TSPI_phoneGetHookSwitch function (tspi.h)
The TSPI_phoneGetHookSwitch function returns the current hookswitch mode of the specified open phone device.
Syntax
LONG TSPIAPI TSPI_phoneGetHookSwitch(
HDRVPHONE hdPhone,
LPDWORD lpdwHookSwitchDevs
);
Parameters
hdPhone
The service provider's opaque handle to the phone whose hookswitch mode is to be retrieved.
lpdwHookSwitchDevs
A pointer to a DWORD-sized location into which the service provider writes the mode of the phone's hookswitch devices. This parameter uses one of the PHONEHOOKSWITCHDEV_ constants. If a bit position is FALSE, the corresponding hookswitch device is onhook. If TRUE, the microphone and/or speaker part of the corresponding hookswitch device is offhook. To find out whether microphone and/or speaker are enabled, TAPI can use TSPI_phoneGetStatus.
Return value
Returns zero if the function succeeds, or an error number if an error occurs. Possible return values are as follows:
PHONEERR_INVALPHONEHANDLE, PHONEERR_RESOURCEUNAVAIL, PHONEERR_INVALPHONESTATE, PHONEERR_OPERATIONFAILED, PHONEERR_NOMEM, PHONEERR_OPERATIONUNAVAIL.
Remarks
After the hookswitch state of a device changes, and if hookswitch monitoring is enabled, TAPI is sent a PHONE_STATE message.
Requirements
| Requirement | Value |
|---|---|
| Target Platform | Windows |
| Header | tspi.h |