LINEDEVSTATUS (Compact 2013)

  • Article

3/26/2014

This structure describes the current status of a line device.

Syntax

typedef struct linedevstatus_tag {
  DWORD dwTotalSize;
  DWORD dwNeededSize;
  DWORD dwUsedSize;
  DWORD dwNumOpens;
  DWORD dwOpenMediaModes;
  DWORD dwNumActiveCalls;
  DWORD dwNumOnHoldCalls;
  DWORD dwNumOnHoldPendCalls;
  DWORD dwLineFeatures;
  DWORD dwNumCallCompletions;
  DWORD dwRingMode;
  DWORD dwSignalLevel;
  DWORD dwBatteryLevel;
  DWORD dwRoamMode;
  DWORD dwDevStatusFlags;
  DWORD dwTerminalModesSize;
  DWORD dwTerminalModesOffset;
  DWORD dwDevSpecificSize;
  DWORD dwDevSpecificOffset;
} LINEDEVSTATUS, FAR* LPLINEDEVSTATUS;

Members

  • dwTotalSize
    Total size in bytes allocated to this data structure.
  • dwNeededSize
    Size, in bytes, for this data structure that is needed to hold all the returned data.
  • dwUsedSize
    Size, in bytes, of the portion of this data structure that contains useful data.
  • dwNumOpens
    Number of active opens on the line device.
  • dwOpenMediaModes
    Value that specifies a bit array that indicates for which media modes the line device is currently open.
  • dwNumActiveCalls
    Number of calls on the line in call states other than idle, onhold, onholdpendingtransfer, and onholdpendingconference.
  • dwNumOnHoldCalls
    Number of calls on the line in the onhold state.
  • dwNumOnHoldPendCalls
    Number of calls on the line in the onholdpendingtransfer or onholdpendingconference state.
  • dwLineFeatures
    Value that specifies the line-related API functions that are currently available on this line. It uses LINEFEATURE.
  • dwNumCallCompletions
    Number of outstanding call completion requests on the line.
  • dwRingMode
    Current ring mode on the line device.
  • dwSignalLevel
    Current signal level of the connection on the line. This is a value in the range 0x00000000 (weakest signal) to 0x0000FFFF (strongest signal).
  • dwBatteryLevel
    Current battery level of the line device hardware. This is a value in the range 0x00000000 (battery empty) to 0x0000FFFF (battery full).
  • dwRoamMode
    Specifies the current roam mode of the line device. It uses LINEROAMMODE.
  • dwDevStatusFlags
    Size, in bytes, of this data structure that contains useful data, of type It uses LINEDEVSTATUSFLAGS.
  • dwTerminalModesSize
    Size, in bytes, of the variably sized device field that contains an array with DWORD-sized entries.
  • dwTerminalModesOffset
    Offset, in bytes, from the beginning of this data structure. This array is indexed by terminal identifiers, in the range from zero to dwNumTerminals minus one. Each entry in the array specifies the current terminal modes for the corresponding terminal set using the lineSetTerminal function for this line. It uses LINETERMMODE.
  • dwDevSpecificSize
    Size, in bytes, of the variably sized device-specific field.
  • dwDevSpecificOffset
    Offset, in bytes, from the beginning of this data structure.

Remarks

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

The members dwAvailableMediaModes through dwAppInfoOffset are available only to applications that open the line device with an API version of 2.0 or later.

Requirements

Header

tapi.h

See Also

Reference

TAPI Structures