Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

This structure describes the current status of an address. The lineGetAddressStatusfunction and the TSPI_lineGetAddressStatusfunction return the LINEADDRESSSTATUS structure.

Syntax 

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

Total size allocated to this data structure, in bytes.

dwNeededSize

Size for this data structure that is needed to hold all the returned information, in bytes.

dwUsedSize

Size of the portion of this data structure that contains useful information, in bytes.

dwNumInUse

Number of stations that are currently using the address.

dwNumActiveCalls

Number of calls on the address that are in call states other than idle, onhold, onholdpendingtransfer, and onholdpendingconference.

dwNumOnHoldCalls

Number of calls on the address in the onhold state.

dwNumOnHoldPendCalls

Number of calls on the address in the onholdpendingtransfer or onholdpendingconference state.

dwAddressFeatures

Address-related functions that can be invoked on the address in its current state. This member uses one or more of the LINEADDRFEATURE.

dwNumRingsNoAnswer

Number of rings set for this address before an unanswered call is considered as no answer.

dwForwardNumEntries

Number of entries in the array referred to by the dwForwardSizeand dwForwardOffsetmembers.

dwForwardSize

Size of the forwarding information array, in bytes.

dwForwardOffset

Offset from the beginning of the structure to the variably sized field that describes the address's forwarding information. This information is an array of dwForwardNumEntrieselements, of type LINEFORWARD. The offsets of the addresses in the array are relative to the beginning of the LINEADDRESSSTATUSstructure. The offsets dwCallerAddressOffsetand dwDestAddressOffsetin the variably sized field of type LINEFORWARD pointed to by dwForwardOffsetare relative to the beginning of the LINEADDRESSSTATUSdata structure (the "root" container). The size of the array is specified by the dwForwardSizemember.

dwTerminalModesSize

Size of the terminal modes array, in bytes.

dwTerminalModesOffset

Offset from the beginning of the structure to the variably sized device field containing an array with DWORD-sized entries, that use one or more of the LINETERMMODE. This array is indexed by terminal identifiers, in the range from zero to one less than the dwNumTerminalsmember. Each entry in the array specifies the current terminal modes for the corresponding terminal set with the lineSetTerminalfunction for this address. The size of the array is specified by the dwTerminalModesSizemember.

dwDevSpecificSize

Size of the device-specific field, in bytes.

dwDevSpecificOffset

Offset from the beginning of this structure to the variably sized device-specific field. The size of the field is specified by dwDevSpecificSize.

Remarks

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

This data structure is returned by lineGetAddressStatus. When items in this data structure change as a consequence of activities on the address, a LINE_ADDRESSSTATEmessage 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

Header tapi.h
Windows Embedded CE Windows CE 3.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also