ITAddress::put_DoNotDisturb method (tapi3if.h)

The put_DoNotDisturb method sets the do not disturb status. The do not disturb feature may not be available on all addresses.

Syntax

HRESULT put_DoNotDisturb(
  VARIANT_BOOL fDoNotDisturb
);

Parameters

fDoNotDisturb

If VARIANT_TRUE, the do not disturb feature will be activated. If VARIANT_FALSE, the do not disturb feature will be deactivated and all forwarding canceled.

Return value

This method can return one of these values.

Return code Description
S_OK
Method succeeded.
E_INVALIDARG
The fDoNotDisturb parameter is not a valid pointer.
E_OUTOFMEMORY
Insufficient memory exists to perform the operation.
TAPI_E_TIMEOUT
The operation failed because the TAPI 3 DLL timed it out. The timeout interval is two minutes.

Remarks

The DoNotDisturb feature is implemented using forwarding. If put_DoNotDisturb is called with VARIANT_TRUE, Tapi3.dll creates a LINEFORWARD list with the mode set to LINEFORWARDMODE_UNCOND and only one LINEFORWARD item with the destination address set to NULL. If put_DoNotDisturb is called with VARIANT_FALSE, Tapi3.dll cancels forwarding completely on this address, even those forwarding rules set with ITAddress::Forward.

Requirements

   
Target Platform Windows
Header tapi3if.h (include Tapi3.h)
Library Uuid.lib
DLL Tapi3.dll

See also

Address Object

ITAddress

get_DoNotDisturb