ITAutomatedPhoneControl::get_AutoStopRingOnOffHook method (tapi3if.h)
The get_AutoStopRingOnOffHook method retrieves the current value of 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 get_AutoStopRingOnOffHook(
[out] VARIANT_BOOL *pfEnabled
);
Parameters
[out] pfEnabled
If VARIANT_TRUE, automatic incoming ring termination when the phone goes offhook is enabled. If VARIANT_FALSE, automatic incoming ring termination when the phone goes offhook is disabled.
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 |