LINE_GENERATE

The LINE_GENERATE message is sent to the LINEEVENT callback function to notify TAPI that the current digit or tone generation has terminated. Note that only one such generation request can be in progress on a given call at any time. This message is also sent when digit or tone generation is canceled.

LINE_GENERATE
htLine = (HTAPILINE) hLineDevice;
htCall = (HTAPICALL) hCallDevice;
dwMsg = (DWORD) LINE_GENERATE;
dwParam1 = (DWORD) LineGenerateTerminate;
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_GENERATE.

dwParam1

Specifies the reason why digit or tone generation was terminated, and can be one of the following LINEGENERATETERM_ constants:

LINEGENERATETERM_DONE

The requested number of digits have been generated, or the requested tones have been generated for the requested duration.

LINEGENERATETERM_CANCEL

The digit or tone generation request was canceled by an intervening call to TSPI_lineGenerateTone or TSPI_lineGenerateDigits, or because the call terminated.

dwParam2

The dwEndToEndID parameter that was specified in the original TSPI_lineGenerateDigits or TSPI_lineGenerateTone request for which this is the final result.

dwParam3

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

Remarks

Calling either TSPI_lineGenerateDigits or TSPI_lineGenerateTone while digit or tone generation is in progress cancels the current digit or tone generation request and starts a new request and also results 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.

See Also

LINEEVENT, LINEGENERATETERM_ Constants, TSPI_lineGenerateDigits, TSPI_lineGenerateTone