2.2.6.24 LINEDEVSTATUS

The LINEDEVSTATUS packet describes the current status of a line device. LINEDEVSTATUS is supplied by the server in the field VarData of the returned version of the GetLineDevStatus packet if the request is completed successfully.

dwTotalSize (4 bytes): The total size, in bytes, allocated to this packet.

dwNeededSize (4 bytes): The size, in bytes, for this packet that is needed to hold all the returned information.

dwUsedSize (4 bytes): The size, in bytes, of the portion of this packet that contains useful information.

dwNumOpens (4 bytes): The number of active opens on the line device.

dwOpenMediaModes (4 bytes): The bit array that indicates the media types for which the line device is currently open.

dwNumActiveCalls (4 bytes): The number of calls on the line in call states other than idle, onHold, onHoldPendingTransfer, and onHoldPendingConference.

dwNumOnHoldCalls (4 bytes): the number of calls on the line in the onHold state.

dwNumOnHoldPendCalls (4 bytes): The number of calls on the line in the onHoldPendingTransfer or onHoldPendingConference state.

dwLineFeatures (4 bytes): Line-related functions that are currently available on this line. This member MUST use one or more of the LINEFEATURE_Constants.

dwNumCallCompletions (4 bytes): The number of outstanding call-completion requests on the line.

dwRingMode (4 bytes): The current ring mode on the line device.

dwSignalLevel (4 bytes): The current signal level of the connection on the line. This MUST be a value in the range 0x00000000 (weakest signal) to 0x0000FFFF (strongest signal).

dwBatteryLevel (4 bytes): The current battery level of the line device hardware. This MUST be a value in the range 0x00000000 (battery empty) to 0x0000FFFF (battery full).

dwRoamMode (4 bytes): The current roam mode of the line device. This member MUST use one of the LINEROAMMODE_Constants.

dwDevStatusFlags (4 bytes): The flags that indicate status information, such as whether the device is locked. It consists of one or more members of LINEDEVSTATUSFLAGS_Constants.

dwTerminalModesSize (4 bytes): The size, in bytes, of the variably sized device field containing an array of current terminal modes.

dwTerminalModesOffset (4 bytes): The offset, in bytes, from the beginning of the packet to an array of current terminal modes. This array is indexed by terminal IDs, in the range from 0 to dwNumTerminals minus one. Each entry in the array specifies the current terminal modes for the corresponding terminal set using the SetTerminal packet for this line. Each entry is a DWORD that specifies one or more of the LINETERMMODE_Constants. The size of the array MUST be specified by dwTerminalModesSize.

dwDevSpecificSize (4 bytes): The size, in bytes, of the variably sized device-specific field. If the device-specific information is a pointer to a string, the size MUST include the null terminator.

dwDevSpecificOffset (4 bytes): The offset, in bytes, from the beginning of the packet to the device-specific field. The size of the field MUST be specified by dwDevSpecificSize.

dwAvailableMediaModes (4 bytes): Indicates the media types that can be invoked on new calls created on this line device when the dwLineFeatures member indicates that new calls are possible. If this member is 0, it indicates that the service provider either does not know or cannot indicate which media types are available, in which case any or all of the media types indicated in the dwMediaModes member in LINEDEVCAPS can be available.

dwAppInfoSize (4 bytes): The size, in bytes, of the array that identifies the applications that have the line open.

dwAppInfoOffset (4 bytes): The offset from the beginning of the packet to an array of LINEAPPINFO packets. The dwNumOpens member indicates the number of elements in the array. Each element in the array identifies an application that has the line open. The size of the array MUST be specified by dwAppInfoSize.

Device-specific extensions SHOULD use the DevSpecific (dwDevSpecificSize and dwDevSpecificOffset) variably sized area of this packet.

The members dwAvailableMediaModes through dwAppInfoOffset are available only to line device's with a TAPI version of 2.0, 2.1, 2.2, 3.0, or 3.1.