2.2.6.7 LINEADDRESSSTATUS

The LINEADDRESSSTATUS packet describes the current status of an address. LINEADDRESSSTATUS is supplied by the server in the field VarData of the returned version of the GetAddressStatus packet if the request is completed successfully.

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
dwTotalSize
dwNeededSize
dwUsedSize
dwNumInUse
dwNumActiveCalls
dwNumOnHoldCalls
dwNumOnHoldPendCalls
dwAddressFeatures
dwNumRingsNoAnswer
dwForwardNumEntries
dwForwardSize
dwForwardOffset
dwTerminalModesSize
dwTerminalModesOffset
dwDevSpecificSize
dwDevSpecificOffset

dwTotalSize (4 bytes): An unsigned 32-bit integer. The total size, in bytes, allocated to this packet.

dwNeededSize (4 bytes): An unsigned 32-bit integer. The size, in bytes, for this packet that is needed to hold all the returned information.

dwUsedSize (4 bytes): An unsigned 32-bit integer. The size, in bytes, of the portion of this packet that contains useful information.

dwNumInUse (4 bytes):  An unsigned 32-bit integer. The number of stations that are currently using the address.

dwNumActiveCalls (4 bytes): An unsigned 32-bit integer. The number of calls on the address that are in call states other than idle, onHold, onHoldPendingTransfer, and onHoldPendingConference.

dwNumOnHoldCalls (4 bytes): An unsigned 32-bit integer. The number of calls on the address in the onHold state.

dwNumOnHoldPendCalls (4 bytes): An unsigned 32-bit integer. The number of calls on the address in the onHoldPendingTransfer or onHoldPendingConference state.

dwAddressFeatures (4 bytes): An unsigned 32-bit integer. Address-related functions that can be invoked on the address in its current state. This field MUST use one or more of the LINEADDRFEATURE_Constants.

dwNumRingsNoAnswer (4 bytes): An unsigned 32-bit integer. The number of rings set for this address before an unanswered call is considered "no answer."

dwForwardNumEntries (4 bytes): An unsigned 32-bit integer. The number of entries in the array referred to by dwForwardSize and dwForwardOffset.

dwForwardSize (4 bytes): An unsigned 32-bit integer. The size, in bytes, of the forwarding information array.

dwForwardOffset (4 bytes): An unsigned 32-bit integer. The offset from the beginning of the packet to the variably sized field that describes the address's forwarding information. This information MUST be an array of dwForwardNumEntries elements, of type LINEFORWARD. The offsets of the addresses in the array are relative to the beginning of the LINEADDRESSSTATUS packet. The offsets dwCallerAddressOffset and dwDestAddressOffset in the variably sized field of type LINEFORWARD pointed to by dwForwardOffset are relative to the beginning of the LINEADDRESSSTATUS packet (the "root" container). The size of the array MUST be specified by dwForwardSize.

dwTerminalModesSize (4 bytes):  An unsigned 32-bit integer.

The size of the terminal modes array, in bytes.

dwTerminalModesOffset (4 bytes): An unsigned 32-bit integer. The offset from the beginning of the packet to the variably sized device field containing an array with DWORD-sized entries that use one or more of the LINETERMMODE_Constants. This array is indexed by terminal identifiers, in the range from 0 to one less than dwNumTerminals. Each entry in the array specifies the current terminal modes for the corresponding terminal set with the SetTerminal packet for this address. The size of the array MUST be specified by dwTerminalModesSize.

dwDevSpecificSize (4 bytes): An unsigned 32-bit integer. The size, in bytes, of the device-specific field.

dwDevSpecificOffset (4 bytes): An unsigned 32-bit integer. The offset from the beginning of this packet to the variably sized device-specific field. The size of the field MUST be specified by dwDevSpecificSize.

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

This packet MUST be returned by the GetAddressStatus packet. When items in this packet change as a consequence of activities on the address, a LINE_ADDRESSSTATE packet is sent. A parameter to this packet is the address state, one of the LINEADDRESSSTATE_Constants, which indicates that the status item in this record changed.