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;
} PHONESTATUS, FAR *LPPHONESTATUS;
| Fields | The PHONESTATUS structure has the following fields: |
| 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 this data structure that contains useful information. | |
| dwStatusFlags This field provides a collection of status flags for this phone device, of type PHONESTATUSFLAGS. Values are: | |
| PHONESTATUSFLAGS_CONNECTED Specifies whether the phone is currently connected to the API. TRUE if connected, FALSE otherwise. | |
| PHONESTATUSFLAGS_SUSPENDED Specifies whether the API's manipulation of the phone device is suspended or not. TRUE is suspended, FALSE otherwise. An app's use of a phone device may be temporarily suspended when the switch wants to manipulate the phone in a way that cannot tolerate interference from the application. | |
| dwRingMode Specifies the current ring mode of a phone device. | |
| dwRingVolume Specifies the current ring volume of a phone device. This is a value between 0x00000000 which is silence and 0x0000FFFF which is maximum volume. | |
| dwHandsetHookSwitchMode Specifies the current hook switch mode of the phone's handset, of type PHONEHOOKSWITCHMODE. Values are: | |
| PHONEHOOKSWITCHMODE_ONHOOK The device's mic and speaker are both onhook. | |
| PHONEHOOKSWITCHMODE_MIC The devicer's mic is active, the speaker is mute. | |
| PHONEHOOKSWITCHMODE_SPEAKER The device's speaker is active, the mic is mute. | |
| PHONEHOOKSWITCHMODE_MICSPEAKER The device's mic and speaker are both active. | |
| dwHandsetVolume Specifies the current speaker volume of the phone's handset device. This is a value between 0x00000000 which is silence and 0x0000FFFF which is maximum volume. | |
| dwHandsetGain Specifies the current mic gain of the phone's handset device. This is a value between 0x00000000 which is silence and 0x0000FFFF which is maximum gain. | |
| dwSpeakerHookSwitchMode Specifies the current hook switch mode of the phone's speakerphone, of type PHONEHOOKSWITCHMODE. Values are: | |
| PHONEHOOKSWITCHMODE_ONHOOK The device's mic and speaker are both onhook. | |
| PHONEHOOKSWITCHMODE_MIC The devicer's mic is active, the speaker is mute. | |
| PHONEHOOKSWITCHMODE_SPEAKER The device's speaker is active, the mic is mute. | |
| PHONEHOOKSWITCHMODE_MICSPEAKER The device's mic and speaker are both active. | |
| dwSpeakerVolume Specifies the current speaker volume of the phone's speaker device. This is a value between 0x00000000 which is silence and 0x0000FFFF which is maximum volume. | |
| dwSpeakerGain Specifies the current speaker volume of the phone's speaker device. This is a value between 0x00000000 which is silence and 0x0000FFFF which is maximum volume. Specifies the current mic gain of the phone's speaker device. This is a value between 0x00000000 which is silence and 0x0000FFFF which is maximum gain. | |
| dwHeadsetHookSwitchMode Specifies the current hook switch mode of the phone's headset, of type PHONEHOOKSWITCHMODE. Values are: | |
| PHONEHOOKSWITCHMODE_ONHOOK The device's mic and speaker are both onhook. | |
| PHONEHOOKSWITCHMODE_MIC The devicer's mic is active, the speaker is mute. | |
| PHONEHOOKSWITCHMODE_SPEAKER The device's speaker is active, the mic is mute. | |
| PHONEHOOKSWITCHMODE_MICSPEAKER The device's mic and speaker are both active. | |
| dwHeadsetVolume Specifies the current speaker volume of the phone's headset device. This is a value between 0x00000000 which is silence and 0x0000FFFF which is maximum volume. | |
| dwHeadsetGain Specifies the current mic gain of the phone's headset device. This is a value between 0x00000000 which is silence and 0x0000FFFF which is maximum gain. | |
| dwDisplaySize dwDisplayOffset The size in bytes and the offset in bytes from the beginning of this data structure of the variable sized field containing the phone's current display information. | |
| dwLampModesSize dwLampModesOffset The size in bytes and the offset in bytes from the beginning of this data structure of the variable sized field containing the phone's current lamp modes. | |
| dwOwnerNameSize dwOwnerNameOffset The size in bytes and the offset in bytes from the beginning of this data structure of the variable sized field containing the name of the application that is the the current owner of the phone device. The name is the application name provided by the application when it invoked phoneInitialize. If no application name was supplied, then the application's module name is used instead. If the phone currently has no owner, then dwOwnerNameSize is zero. | |
| dwDevSpecificSize dwDevSpecificOffset The size in bytes and the offset in bytes from the beginning of this data structure of the variable sized device specific field. | |
| Extensibility | Device specific extensions should use the DevSpecific (dwDevSpecificSize and dwDevSpecificOffset) variable sized area of this data structure. |
| Comments | None. |
| See Also | Functions: phoneGetStatus Data types: PHONELAMPMODE, PHONEHOOKSWITCHDEV, PHONEHOOKSWICTHMODE, PHONESTATUSFLAGS, PHONESTATE |