ITBasicCallControl::SwapHold method (tapi3if.h)

The SwapHold method swaps the call (which is active) with the specified call on hold.

Swapping the active call with the call on consultation hold allows the application to toggle between these two calls. This is typical in call waiting.

Syntax

HRESULT SwapHold(
  ITBasicCallControl *pCall
);

Parameters

pCall

Call, currently on hold, that is to be made active.

Return value

This method can return one of these values.

Return code Description
S_OK
Method succeeded.
E_FAIL
This operation is not supported.
E_POINTER
The pCall parameter is not a valid pointer.
E_INVALIDARG
The pCall parameter does not describe a currently existing call.
E_OUTOFMEMORY
Insufficient memory exists to perform the operation.
E_OPERATIONFAILED
The operation failed.
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.

Requirements

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

See also

Call Object

ITBasicCallControl

lineSwapHold