phoneGetHookSwitch
The phoneGetHookSwitch
function returns the current hookswitch mode of the specified open phone
device.
LONG phoneGetHookSwitch(
|
HPHONE hPhone, |
|
|
LPDWORD lpdwHookSwitchDevs |
|
|
); |
|
Parameters
hPhone
A handle to
the open phone device.
lpdwHookSwitchDevs
A pointer to
a DWORD-sized location to be filled with the mode of the phone's hookswitch devices.
If a bit position is FALSE, the corresponding hookswitch device is on-hook; if
TRUE, the microphone and/or speaker part of the corresponding hookswitch device
is offhook. To find out whether the microphone and/or speaker are enabled, the
application can use phoneGetStatus. This parameter uses the following
PHONEHOOKSWITCHDEV_ constants:
PHONEHOOKSWITCHDEV_HANDSET
The phone's
handset.
PHONEHOOKSWITCHDEV_SPEAKER
The phone's
speakerphone or adjunct.
PHONEHOOKSWITCHDEV_HEADSET
The phone's
headset.
Return Values
Returns zero
if the request is successful or a negative error number if an error has
occurred. Possible return values are:
PHONEERR_INVALPHONEHANDLE,
PHONEERR_NOMEM, PHONEERR_INVALPOINTER, PHONEERR_RESOURCEUNAVAIL,
PHONEERR_INVALPHONESTATE, PHONEERR_OPERATIONFAILED, PHONEERR_OPERATIONUNAVAIL,
PHONEERR_UNINITIALIZED.
Remarks
After the
hookswitch state of a device changes, and if hookswitch monitoring is enabled,
the application is sent a PHONE_STATE message.
See Also