|
LINE_GATHERDIGITS
The LINE_GATHERDIGITS message is sent when the current buffered
digit-gathering request has terminated or is canceled. The digit buffer may be examined after
this message has been received by the application.
LINE_GATHERDIGITS
dwDevice = (DWORD) hCall;
dwCallbackInstance = (DWORD) hCallback;
dwParam1 = (DWORD) GatherTermination;
dwParam2 = (DWORD) 0;
dwParam3 = (DWORD) 0;
Parameters
dwDevice
A handle to the call.
dwCallbackInstance
The callback instance supplied when opening the line.
dwParam1
The reason why digit gathering was terminated. This parameter must be one and
only one of the following LINEGATHERTERM_ constants:
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 this application, by another application, or
because the call terminated.
dwParam2
Unused.
dwParam3
The "tick count" (number of milliseconds since Windows started) at which the
digit gathering completed. For API versions prior to 0x0002000, this parameter
is unused.
Return Values
No return value.
Remarks
The LINE_GATHERDIGITS message is only sent to the application that initiated
the digit gathering on the call using lineGatherDigits.
If the lineGatherDigits function is used to cancel a previous request to gather digits, TAPI sends a
LINE_GATHERDIGITS message with dwParam1 set to LINEGATHERTERM_CANCEL to the application indicating that the
originally specified buffer contains the digits gathered up to the cancellation.
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,
LINE_MONITORDIGITS, LINE_MONITORMEDIA, LINE_MONITORTONE), 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), then TAPI will provide a timestamp
at the point closest to the service provider generating the event so that the
synthesized timestamp is as accurate as possible.
See Also
LINE_GENERATE, LINE_MONITORDIGITS, LINE_MONITORMEDIA, LINE_MONITORTONE, lineGatherDigits
Related Links
Software for Delphi and C++ Builder developers
Software for Visual Studio .NET developers
Software for Visual Basic 6 developers
Delphi Tips&Tricks
MegaDetailed.NET
More Online Helps
Win32 Programmer's Reference (win32.hlp)
Win32 Multimedia Programmer's Reference (mmedia.hlp)
OLE Programmer's Reference (ole.hlp)
Microsoft Windows Pen API Programmer's Reference (penapi.hlp)
Microsoft Windows Sockets 2 Reference (sock2.hlp)
Unix Manual Pages
|
