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 a phone device. The phoneGetStatusand TSPI_phoneGetStatusfunctions return this structure.

Syntax 

typedef struct phonestatus_tag {
  DWORD 
dwTotalSize;
  DWORD 
dwNeededSize;
  DWORD 
dwUsedSize;
  DWORD 
dwStatusFlags; 
  DWORD 
dwNumOwners;
  DWORD 
dwNumMonitors;
  DWORD 
dwRingMode;
  DWORD 
dwRingVolume;
  DWORD 
dwHandsetHookSwitchMode;
  DWORD 
dwHandsetVolume;
  DWORD 
dwHandsetGain;
  DWORD 
dwSpeakerHookSwitchMode;
  DWORD 
dwSpeakerVolume;
  DWORD 
dwSpeakerGain;
  DWORD 
dwHeadsetHookSwitchMode;
  DWORD 
dwHeadsetVolume;
  DWORD 
dwHeadsetGain;
  DWORD 
dwDisplaySize;
  DWORD 
dwDisplayOffset;
  DWORD 
dwLampModesSize;
  DWORD 
dwLampModesOffset;
  DWORD 
dwOwnerNameSize;
  DWORD 
dwOwnerNameOffset;
  DWORD 
dwDevSpecificSize;
  DWORD 
dwDevSpecificOffset;
  DWORD 
dwPhoneFeatures;
} PHONESTATUS, FAR* LPPHONESTATUS;

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 information.

dwUsedSize

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

dwStatusFlags

Set of status flags for this phone device. This member uses one of the PHONESTATUSFLAGS.

dwNumOwners

Number of application modules with owner privilege for the phone.

dwNumMonitors

Number of application modules with monitor privilege for the phone.

dwRingMode

Current ring mode of a phone device.

dwRingVolume

Current ring volume of a phone device. This is a value between 0x00000000 (silence) and 0x0000FFFF (maximum volume).

dwHandsetHookSwitchMode

Current hookswitch mode of the phone's handset. This member uses one of the PHONEHOOKSWITCHMODE.

dwHandsetVolume

Current speaker volume of the phone's handset device. This is a value between 0x00000000 (silence) and 0x0000FFFF (maximum volume).

dwHandsetGain

Current microphone gain of the phone's handset device. This is a value between 0x00000000 (silence) and 0x0000FFFF (maximum gain).

dwSpeakerHookSwitchMode

Current hookswitch mode of the phone's speakerphone. This member uses one of the PHONEHOOKSWITCHMODE constants.

dwSpeakerVolume

Current speaker volume of the phone's speaker device. This is a value between 0x00000000 (silence) and 0x0000FFFF (maximum volume).

dwSpeakerGain

Current microphone gain of the phone's speaker device. This is a value between 0x00000000 (silence) and 0x0000FFFF (maximum gain).

dwHeadsetHookSwitchMode

Current hookswitch mode of the phone's headset. This member uses one of the PHONEHOOKSWITCHMODE_ constants.

dwHeadsetVolume

Current speaker volume of the phone's headset device. This is a value between 0x00000000 (silence) and 0x0000FFFF (maximum volume).

dwHeadsetGain

Current microphone gain of the phone's headset device. This is a value between 0x00000000 (silence) and 0x0000FFFF (maximum gain).

dwDisplaySize

Size, in bytes, of the variably sized field containing the phone's current display information.

dwDisplayOffset

Offset, in bytes, from the beginning of this data structure.

dwLampModesSize

Size, in bytes, of the variably sized field containing the phone's current lamp modes.

dwLampModesOffset

Offset, in bytes, from the beginning of this data structure.

dwOwnerNameSize

Size, in bytes, of the variably sized field containing the name of the application that is the current owner of the phone device. The name is the application name provided by the application when it invoked with phoneInitializeEx. If no application name was supplied, the application's file name is used instead. If the phone currently has no owner, dwOwnerNameSizeis zero.

dwOwnerNameOffset

Offset, in bytes, from the beginning of this data structure.

dwDevSpecificSize

The size, in bytes, of the variably sized device-specific field

dwDevSpecificOffset

Offset, in bytes, from the beginning of this data structure.

dwPhoneFeatures

These flags indicate which Telephony API functions can be invoked on the phone, considering the availability of the feature in the device capabilities, the current device state, and device ownership of the invoking application. A zero indicates the corresponding feature cannot be invoked by the application on the phone in its current state; a one indicates the feature can be invoked. This member uses one or more of the PHONEFEATURE.

Remarks

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

The dwPhoneFeaturesmember is available only to applications that open the phone device with an API version of 2.0 or later.

Requirements

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

See Also