LINECALLSTATUS

The LINECALLSTATUS structure describes the current status of a call. The information in this structure depends on the device capabilities of the address, the ownership of the call by the invoking application, and the current state of the call being queried. The lineGetCallStatus and TSPI_lineGetCallStatus functions return the LINECALLSTATUS structure.

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

  DWORD  dwCallState;
  DWORD  dwCallStateMode;
  DWORD  dwCallPrivilege;
  DWORD  dwCallFeatures;

  DWORD  dwDevSpecificSize;
  DWORD  dwDevSpecificOffset;

  DWORD  dwCallFeatures2;
  SYSTEMTIME  tStateEntryTime;
} LINECALLSTATUS, FAR *LPLINECALLSTATUS; 

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.

dwCallState

Specifies the current call state of the call using one of the LINECALLSTATE_ constants.

dwCallStateMode

The interpretation of the dwCallStateMode member is call-state-dependent. In many cases, the value will be zero. The following table shows dwCallStateMode types for a given dwCallState value.

dwCallState	dwCallStateMode
LINECALLSTATE_BUSY	LINEBUSYMODE_ Constants
LINECALLSTATE_CONNECTED	LINECONNECTEDMODE_ Constants
LINECALLSTATE_DIALTONE	LINEDIALTONEMODE_ Constants
LINECALLSTATE_DISCONNECTED	LINEDISCONNECTMODE_ Constants
LINECALLSTATE_OFFERING	LINEOFFERINGMODE_ Constants
LINECALLSTATE_SPECIALINFO	LINESPECIALINFO_ Constants

dwCallPrivilege

The application's privilege for this call. This member uses one or more of the LINECALLPRIVILEGE_ constants.

dwCallFeatures

These flags indicate the Telephony API functions that can be invoked on the call, given the availability of the feature in the device capabilities, the current call state, and call ownership of the invoking application. A zero indicates the corresponding feature cannot be invoked by the application on the call in its current state; a one indicates the feature can be invoked. This member uses LINECALLFEATURE_ Constants.

dwDevSpecificSize

dwDevSpecificOffset

The size, in bytes, of the variably sized device-specific field, and the offset, in bytes, from the beginning of this data structure.

dwCallFeatures2

Indicates additional functions can be invoked on the call, given the availability of the feature in the device capabilities, the current call state, and call ownership of the invoking application. An extension of the dwCallFeatures member. This member uses LINECALLFEATURE2_ Constants.

tStateEntryTime

The Coordinated Universal Time at which the current call state was entered.

Remarks

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

The application is sent a LINE_CALLSTATE message whenever the call state of a call changes. This message only provides the new call state of the call. Additional status about a call is available with lineGetCallStatus.

The members dwCallFeatures2 and tStateEntryTime are available only to applications that open the line device with an API version of 2.0 or later.

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_CALLSTATE, LINEDIALPARAMS, lineGetCallStatus, TSPI_lineGetCallStatus