2.2.4.2.1.17 LINE_LINEDEVSTATE

The LINE_LINEDEVSTATE packet is sent when the state of a line device has changed. The GetLineDevStatus packet can be sent to determine the new status of the line.


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

hRemoteLine

Msg

OpenContext

Param1

Param2

Param3

Param4

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.

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

Msg (4 bytes): An unsigned 32-bit integer. The packet type; MUST be set to 0x00000008 (LINE_LINEDEVSTATE).

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 line device status item that has changed. The parameter MUST be one or more of the LINEDEVSTATE_Constants.

Param2 (4 bytes): An unsigned 32-bit integer. The interpretation of this field depends on the value of the Param1 field. If the Param1 field is set to LINEDEVSTATE_RINGING, the field MUST contain the ring mode that the switch instructs the line to ring. Valid ring modes are numbers in the range from one to dwNumRingModes, where dwNumRingModes is a line device capability.

If the Param1 field is set to LINEDEVSTATE_REINIT, this field MUST contain LINE_CREATE (0x00000013) or LINE_LINEDEVSTATE(0x00000008). If this field is set to zero, a Shutdown packet MUST be sent.

Param3 (4 bytes): An unsigned 32-bit integer. The interpretation of this parameter depends on the value of the Param1 field. If the Param1 field is set to LINEDEVSTATE_RINGING, this field MUST contain the ring count for this ring event. The ring count starts at zero.

If the Param1 field is set to LINEDEVSTATE_REINIT, this field MUST be set to one of the LINEDEVSTATE_Constants values.

Param4 (4 bytes): An unsigned 32-bit integer. This MUST be ignored on receipt and can be any value.