ITBasicCallControl::Transfer method (tapi3if.h)

Article
02/22/2024

The Transfer method transfers the current call to the destination address.

Syntax

HRESULT Transfer(
  [in] ITBasicCallControl *pCall,
  [in] VARIANT_BOOL       fSync
);

Parameters

[in] pCall

Pointer to ITBasicCallControl interface of consultation call created for the transfer.

[in] fSync

Indicates whether the method should be completed synchronously (VARIANT_TRUE) or asynchronously (VARIANT_FALSE).

Return value

This method can return one of these values.

Value	Meaning
S_OK	Method succeeded.
E_INVALIDARG	The pCall parameter does not point to a valid call.
E_FAIL	Transfers not supported.
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

Some service providers do not support this operation while streaming is active. The application may need to call ITStream::StopStream or ITSubStream::StopSubStream prior to the operation and ITStream::StartStream or ITSubStream::StartSubStream following completion of the operation.

Call transfer involves setting up a consultation call in preparation for the transfer. pCall is the ITBasicCallControl pointer returned by ITAddress::CreateCall following the creation of a consultation call. ITBasicCallControl::Finish (FM_ASTRANSFER) completes the transfer.

If the consultation call is not in the CONNECTED state when Transfer is called, TAPI will use the destination address (as specified when the consultation call was first created via ITAddress::CreateCall) and try to connect at that time. If the original call had a NULL destination address, Transfer will fail with E_INVALIDARG.

Requirements

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