2.2.4.2.1.15 LINE_GENERATE

The LINE_GENERATE packet is sent to notify the application that the current digit or tone generation has terminated. Only one generation request can be in progress for a particular call at any time. This packet is also sent when digit or tone generation is canceled. The LINE_GENERATE packet is sent only if the client initiated the digit generation on the call using GenerateDigits or if the client initiated the tone generation using GenerateTone.


0


1


2


3


4


5


6


7


8


9

1
0


1


2


3


4


5


6


7


8


9

2
0


1


2


3


4


5


6


7


8


9

3
0


1

TotalSize

InitContext

fnPostProcessProcHandle

hCall

Msg

OpenContext

Param1

Param2

Param3

hRemoteLine

TotalSize (4 bytes): An unsigned 32-bit integer. The total size of the asynchronous event packet.

InitContext (4 bytes): An unsigned 32-bit integer. The opaque, client-specified session value that MUST be equal to the InitContext value that is specified in the original scoping of the line Initialize request.

fnPostProcessProcHandle (4 bytes): An unsigned 32-bit integer. MUST be set to zero when sent and MUST be ignored on receipt.

hCall (4 bytes): An HCALL. The handle to the call or line device that is associated with the asynchronous event.

Msg (4 bytes): An unsigned 32-bit integer. The packet type, which MUST be set to 0x00000007 (LINE_GENERATE).

OpenContext (4 bytes): An unsigned 32-bit integer. The opaque client-specified context value that MUST be equal to the OpenContext value that is specified in the original scoping of the line Open request.

This information MUST be passed back to the application with each completion and event that is associated with the handle of the line or call on the line. This field is not interpreted by TAPI.

Param1 (4 bytes): An unsigned 32-bit integer. The reason why digit or tone generation has been terminated. This parameter MUST be one of the LINEGENERATETERM_Constants.

Param2 (4 bytes): An unsigned 32-bit integer. This value MUST be equal to the dwEndToEndID value that was specified in the original GenerateDigits request.

Param3 (4 bytes): An unsigned 32-bit integer. The "tick count" at which the digit or tone generation is completed. For TAPI versions earlier than 2.0, this parameter is unused.

hRemoteLine (4 bytes): An unsigned 32-bit integer. The client handle for the line value.