Platform SDK: TAPI

LINEADDRESSSTATUS

The LINEADDRESSSTATUS structure describes the current status of an address. The lineGetAddressStatus function and the TSPI_lineGetAddressStatus function return the LINEADDRESSSTATUS structure.

typedef struct lineaddressstatus_tag {
  DWORD  dwTotalSize;
  DWORD  dwNeededSize;
  DWORD  dwUsedSize;

  DWORD  dwNumInUse;
  DWORD  dwNumActiveCalls;
  DWORD  dwNumOnHoldCalls;
  DWORD  dwNumOnHoldPendCalls;

  DWORD  dwAddressFeatures;
  DWORD  dwNumRingsNoAnswer;

  DWORD  dwForwardNumEntries;
  DWORD  dwForwardSize;
  DWORD  dwForwardOffset;

  DWORD  dwTerminalModesSize;
  DWORD  dwTerminalModesOffset;

  DWORD  dwDevSpecificSize;
  DWORD  dwDevSpecificOffset;
} LINEADDRESSSTATUS, FAR *LPLINEADDRESSSTATUS; 

Members

dwTotalSize
The total size, in bytes, allocated to this data structure.
dwNeededSize
The size, in bytes, for this data structure that is needed to hold all the returned information.
dwUsedSize
The size, in bytes, of the portion of this data structure that contains useful information.
dwNumInUse
Specifies the number of stations that are currently using the address.
dwNumActiveCalls
The number of calls on the address that are in call states other than idle, onhold, onholdpendingtransfer, and onholdpendingconference.
dwNumOnHoldCalls
The number of calls on the address in the onhold state.
dwNumOnHoldPendCalls
The number of calls on the address in the onholdpendingtransfer or onholdpendingconference state.
dwAddressFeatures
Specifies the address-related API functions that can be invoked on the address in its current state. This member uses one or more of the LINEADDRFEATURE_ constants.
dwNumRingsNoAnswer
The number of rings set for this address before an unanswered call is considered as no answer.
dwForwardNumEntries
The number of entries in the array referred to by dwForwardSize and dwForwardOffset.
dwForwardSize
dwForwardOffset
The size, in bytes, and the offset, in bytes, from the beginning of this data structure of the variably sized field that describes the address's forwarding information. This information is an array of dwForwardNumEntries elements, of type LINEFORWARD. The offsets of the addresses in the array are relative to the beginning of the LINEADDRESSSTATUS structure. The offsets dwCallerAddressOffset and dwDestAddressOffset in the variably sized field of type LINEFORWARD pointed to by dwForwardSize and dwForwardOffset are relative to the beginning of the LINEADDRESSSTATUS data structure (the "root" container).
dwTerminalModesSize
dwTerminalModesOffset
The size, in bytes, and the offset, in bytes, from the beginning of this data structure of 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 zero to one less than dwNumTerminals. Each entry in the array specifies the current terminal modes for the corresponding terminal set with the lineSetTerminal function for this address.
dwDevSpecificSize
dwDevSpecificOffset
The size, in bytes, and the offset, in bytes, from the beginning of this data structure of the variably sized device-specific field.

Remarks

Device-specific extensions should use the DevSpecific (dwDevSpecificSize and dwDevSpecificOffset) variably sized area of this data structure.

This data structure is returned by the lineGetAddressStatus function. When items in this data structure change as a consequence of activities on the address, a LINE_ADDRESSSTATE message is sent to the application. A parameter to this message is the address state, one of the LINEADDRESSSTATE_ constants, which indicates that the status item in this record changed.

Requirements

  Windows NT/2000: Requires Windows NT 4.0 SP3 or later.
  Windows 95/98: Requires Windows 95 or later.
  Version: Requires TAPI 1.4 or later.
  Header: Declared in Tapi.h.

See Also

LINE_ADDRESSSTATE, LINEFORWARD, lineGetAddressStatus, TSPI_lineGetAddressStatus, lineSetTerminal