Share via


LINE_GATHERDIGITS message

The TSPI LINE_GATHERDIGITS message is sent to the LINEEVENT callback function when the current buffered digit gathering request has terminated. This message is not sent when digit gathering is canceled. The digit buffer can be examined after this message has been received. The effect of examining the digit buffer before this message has been received is undefined.


LINE_GATHERDIGITS
htLine = (HTAPILINE) hLineDevice;
htCall = (HTAPICALL) hCallDevice;
dwMsg = (DWORD) LINE_GATHERDIGITS;
dwParam1 = (DWORD) LineGatherTerminate;
dwParam2 = (DWORD) dwEndToEndID;
dwParam3 = (DWORD) dwTickCount;
            

Parameters

  • htLine
    The TAPI opaque object handle to the line device.

  • htCall
    The TAPI opaque object handle to the call device.

  • dwMsg
    The value LINE_GATHERDIGITS.

  • dwParam1
    Specifies the reason why digit gathering was terminated. This parameter can be one of the LINEGATHERTERM_ constants.

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

  • dwParam3
    Service providers shall insert into dwParam3 the "tick count" (number of milliseconds since Windows started), obtained from GetTickCount, at which the digit gathering completed.

Remarks

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.

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

Requirements

TAPI version

Requires TAPI 2.0 or later

Header

Tapi.h

See also

LINEGATHERTERM_ Constants

TSPI_lineGatherDigits