WaitForDigit Method (timeoutSeconds)

Waits until either a DTMF digit has been detected or the specified time interval has elapsed.

Declaration Syntax

Visual Basic

Visual C++

public string WaitForDigit(
	int timeoutSeconds
)

Public Function WaitForDigit ( _
	timeoutSeconds As Integer _
) As String

public:
String^ WaitForDigit(
	int timeoutSeconds
)

Parameters

timeoutSeconds (Int32): Timeout period in seconds. Negative value means that the timeout should start after playback initiated by the Play(String) or Speak(String) is completed.

Return Value

A string that contains detected digit, if any. This method returns a null reference (Nothing in Visual Basic) if no digits were detected within the specified time interval.

Remarks

This method detects DTMF digits (buttons) pressed by the remote party on a touch-tone phone. When zero timeout is specified, WaitForDigit returns a digit received since the last call to WaitForDigit or GatherDigits(Int32, String, Int32, Int32) or since the beginning of the call, if any. With non-zero timeout WaitForDigit ignores the digits received before the application called this method.

Exceptions

Exception	Condition
TapiDisconnectException	The call has been disconnected while waiting for a digit.