ITDivert interface

Last Updated : Sep 04, 2015 |

The ITDivert interface contains functions for getting and setting the divert flags for the address.

Name

Description

GetDivertAllDestination(BSTR* pDestination)

Gets the current Divert All destination and returns the result in the pDestination value.

SetDivertAllDestination(BSTR dest)

GetDivertSettings(DWORD* pdwDivertSets)

Sets bits in the DWORD pointed to by pdwDivertSets to indicate which of the divert settings are currently active. The bits are defined by the IP_OFFICE_DIVERT_SETTINGS enum.

SetForwardAll(VARIANT_BOOL bOn)

Toggles the ForwardAll setting for the user.

SetForwardBusy(VARIANT_BOOL bOn)

Toggles the ForwardBusy setting for the user.

SetForwardNoAnswer(VARIANT_BOOL bOn)

Toggles the ForwardNoAnswer setting for the user.

SetDoNotDisturb(VARIANT_BOOL bOn)

Toggles the DoNotDisturb setting for the user.

The IP_OFFICE_DIVERT_SETTINGS enum is defined as follows:

typedef enum
{
IPOFF_FWDALL = 0x01,
IPOFF_FWDBUSY = 0x02,
IPOFF_NOANSWER = 0x04,
IPOFF_DND = 0x08,
IPOFF_DESTINATION = 0x10
} IP_OFFICE_DIVERT_SETTINGS;

Therefore, getting a result of 14 (0xe) from GetDivertSettings implies that the user has ForwardBusy, ForwardNoAnswer and DoNotDisturb set. The IPOFF_DESTINATION value is not used by GetDivertSettings, but only by the Fire_DivertSettingsChanged function on the IPOfficePrivateEvents interface.