ITAutomatedPhoneControl::put_AutoStopRingOnOffHook method (tapi3if.h)
The put_AutoStopRingOnOffHook method sets the AutoStopRingOnOffHook property. When this feature is enabled, the phone going offhook results in the termination of any incoming ring produced on the phone (via a call to ITAutomatedPhoneControl::StopRinger).
Syntax
HRESULT put_AutoStopRingOnOffHook(
[in] VARIANT_BOOL fEnabled
);
Parameters
[in] fEnabled
If VARIANT_TRUE, enables automatic incoming ring termination if the phone goes offhook. If VARIANT_FALSE, disables automatic incoming ring termination if the phone goes offhook. The default value is VARIANT_TRUE.
Return value
If the method succeeds, it returns S_OK. Otherwise, it returns an error value.
Remarks
The AutoStopRingOnOffHook property functions only when the value of the PhoneHandlingEnabled property is VARIANT_TRUE. You can set the AutoStopRingOnOffHook property at any time. The reconfiguration takes effect the next time the phone goes offhook.
Requirements
| Requirement | Value |
|---|---|
| Target Platform | Windows |
| Header | tapi3if.h (include Tapi3.h) |
| Library | Uuid.lib |
| DLL | Tapi3.dll |