LINE_GATHERDIGITS (Compact 2013)

  • Article

3/26/2014

This message is sent when the current buffered digit-gathering request has terminated or is canceled. The digit buffer can be examined after this message has been received by the application.

Syntax

LINE_GATHERDIGITS
    hDevice = (DWORD) hCall;
    dwCallbackInstance = (DWORD) hCallback;
    dwParam1 = (DWORD) GatherTermination;
    dwParam2 = (DWORD) 0;
    dwParam3 = (DWORD) 0;

Parameters

  • hDevice
    Handle to the call.
  • dwCallbackInstance
    Callback instance supplied when opening the line.
  • dwParam1
    Reason why digit gathering was terminated. This parameter must be one and only one of the LINEGATHERTERM_ constants.
  • dwParam2
    Not used by this message. Value is NULL.
  • dwParam3
    Tick count (the number of milliseconds since Windows started) at which the digit gathering completed. For TAPI versions earlier than 2.0, this parameter is not used.

Return Value

None.

Remarks

Because the timestamp specified by dwParam3 may have been generated on a computer other than the one on which the application is executing, it is useful only for comparison to other similarly timestamped messages generated on the same line device (LINE_GENERATE (TAPI), LINE_MONITORDIGITS (TAPI), LINE_MONITORMEDIA (TAPI)), in order to determine their relative timing (separation between events). The tick count can wrap around after approximately 49.7 days; applications must take this into account when performing calculations.

If the service provider does not generate the timestamp (for example, if it was created using an earlier version of TAPI), TAPI provides a timestamp at the point closest to the service provider generating the event so that the synthesized timestamp is as accurate as possible.

Note

When an application invokes any asynchronous operation that writes data back into application memory, the application must keep that memory available for writing until a LINE_REPLY or LINE_GATHERDIGITS message is received.

Requirements

Header

tapi.h

See Also

Reference

TAPI Messages
LINE_GENERATE (TAPI)
LINE_MONITORDIGITS (TAPI)
LINE_MONITORMEDIA (TAPI)
LINE_REPLY