ITBasicCallControl::HandoffDirect method (tapi3if.h)

The HandoffDirect method hands off the call to another application. This indicates that the application no longer requires ownership of the call.

Syntax

HRESULT HandoffDirect(
  [in] BSTR pApplicationName
);

Parameters

[in] pApplicationName

Pointer to BSTR containing the specific application name to hand off call to. Can be full path name or executable name.

Return value

This method can return one of these values.

Return code Description
S_OK
Method succeeded.
E_OUTOFMEMORY
Insufficient memory exists to perform the operation.
E_POINTER
The pApplicationName parameter is not a valid pointer.

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.

If the receiving application has not opened the line for the media types involved in the call, the handoff will fail. If TAPI fails to hand off the call, TAPI will call Disconnect.

The application must use SysAllocString to allocate memory for the pApplicationName parameter and use SysFreeString to free the memory when the variable is no longer needed.

Requirements

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

See also

Call Object

Disconnect

Handoffs overview

ITBasicCallControl

lineHandoff