ITForwardInformation::SetForwardType method (tapi3if.h)

The SetForwardType method sets the forwarding mode and destination by caller address.

Syntax

HRESULT SetForwardType(
  [in] long ForwardType,
  [in] BSTR pDestAddress,
  [in] BSTR pCallerAddress
);

Parameters

[in] ForwardType

Line forward mode.

[in] pDestAddress

Pointer to BSTR representation of destination address for forwarding.

[in] pCallerAddress

Pointer to BSTR representation of caller address.

Return value

This method can return one of these values.

Return code Description
S_OK
Method succeeded.
E_POINTER
The pDestAddress or pCallerAddress parameter is not a valid pointer.
E_INVALIDARG
The ForwardType parameter is not valid.
E_OUTOFMEMORY
Insufficient memory exists to perform the operation.

Remarks

The application must use SysAllocString to allocate memory for the pDestAddress and pCallerAddress parameters. The application must use SysFreeString to free the memory when the variables are no longer needed.

Requirements

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

See also

ITAddress::CreateForwardInfoObject

ITAddress::Forward

ITAddress::get_CurrentForwardInfo

ITForwardInformation

Terminal Object