phoneSetHookSwitch (Compact 2013)
3/26/2014
This function sets the hook state of the specified open phone's hookswitch devices to the specified mode. Only the hookswitch state of the hookswitch devices listed is affected.
Syntax
LONG WINAPI phoneSetHookSwitch(
HPHONE hPhone,
DWORD dwHookSwitchDevs,
DWORD dwHookSwitchMode
);
Parameters
- hPhone
Handle to the open phone device. The application must be the owner of the phone.
- dwHookSwitchDevs
Device or devices whose hookswitch mode is to be set. This parameter uses one and only one of the PHONEHOOKSWITCHDEV constants.
- dwHookSwitchMode
The hookswitch mode to set. This parameter uses one and only one of the PHONEHOOKSWITCHMODE constants.
Return Value
Returns a positive request identifier if the function is completed asynchronously or a negative error number if an error occurs. The dwParam2 parameter of the corresponding PHONE_REPLY message is zero if the function succeeds or it is a negative error number if an error occurs. The following table shows the return values for this function.
Value |
Description |
|---|---|
PHONEERR_INVALPHONEHANDLE |
The handle to the open phone device is invalid. |
PHONEERR_OPERATIONUNAVAIL |
The operation is unavailable. |
PHONEERR_NOTOWNER |
The application is not an owner of this call. |
PHONEERR_NOMEM |
Not enough memory is available. |
PHONEERR_INVALHOOKSWITCHDEV |
The hookswitch device is invalid. |
PHONEERR_RESOURCEUNAVAIL |
The resources are unavailable. |
PHONEERR_INVALHOOKSWITCHMODE |
The hookswitch mode is invalid. |
PHONEERR_OPERATIONFAILED |
The operation failed. |
PHONEERR_INVALPHONESTATE |
The phone state is invalid. |
PHONEERR_UNINITIALIZED |
A parameter is uninitialized. |
Remarks
The hookswitch mode is the same for all specified devices. If different settings are desired, this function can be invoked multiple times with a different set of parameters. A PHONE_STATE message is sent to the application after the hookswitch state has changed.
Requirements
Header |
tapi.h |
Library |
TAPI32.dll |