ITAddress::get_DoNotDisturb method (tapi3if.h)
The get_DoNotDisturb method gets the current status of the do not disturb feature on the address. The do not disturb feature may not be available on all addresses.
HRESULT get_DoNotDisturb( [out] VARIANT_BOOL *pfDoNotDisturb );
If VARIANT_TRUE, the do not disturb feature has been activated. If VARIANT_FALSE, the do not disturb feature is not active.
This method can return one of these values.
||This operation is not supported on this address.|
||The pfDoNotDisturb parameter is not a valid pointer.|
||Insufficient memory exists to perform the operation.|
For programmers familiar with TAPI 2.x: The DoNotDisturb feature is implemented using the "forward" feature, if present on the address. When get_DoNotDisturb is called, Tapi3.dll gets the LINEADDRESSSTATUS of the address object, and looks for its LINEFORWARD entries. If one such entry is found and if its dwDestAddressOffset member is 0 (zero), then DoNotDisturb is considered to be turned ON, and therefore VARIANT_TRUE is returned as the value for this method.
|Header||tapi3if.h (include Tapi3.h)|