4.1.0.9 LINE_GATHERDIGITS

This message is sent when the current buffered digit gathering request has terminated. This message is not sent when digit gathering is canceled. The digit buffer may be examined after this message has been received. The effect of examining the digit buffer before this message has been received is undefined.

Sent to

LINEEVENT


Parameters

HTAPILINE htLine
Specifies the TAPI DLL's opaque object handle to the line device.

HTAPICALL htCall
Specifies the TAPI DLL's opaque object handle to the call device.

DWORD dwMsg
The value LINE_GATHERDIGITS

DWORD dwParam1
Specifies the reason why digit gathering was terminated, of type LINEGATHERTERM. Values are:

LINEGATHERTERM_BUFFERFULL
The requested number of digits has been gathered. The buffer is full.

LINEGATHERTERM_TERMDIGIT
One of the termination digits matched a received digit. The matched termination digit is the last digit in the buffer.

LINEGATHERTERM_FIRSTTIMEOUT
The first digit timeout expired. The buffer contains no digits.

LINEGATHERTERM_INTERTIMEOUT
The inter digit timeout expired. The buffer contains at least one digit.

LINEGATHERTERM_CANCEL
The request was canceled by a subsequent TSPI_lineGatherDigits request, or because the call terminated.

DWORD dwParam2
The dwEndToEndID that was specified in the original TSPI_lineGatherDigits request for which this is the final result.

DWORD dwParam3
Unused.

Comments

Calling TSPI_lineGatherDigits while digit gathering is in progress cancels the current digit gathering request and starts a new one, but does not result in the Service Provider sending this message.

Comparison

The corresponding message at the TAPI level does not include an end-to-end ID. End to end marking is only done at the TSPI level.

See Also

Functions: TSPI_lineGatherDigits