ITBasicCallControl::Conference method (tapi3if.h)

Article
02/22/2024

The Conference method adds a consultation call to the conference in which the current call is a participant. If an associated ITCallHub object does not exist, it is created.

Syntax

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

Parameters

[in] pCall

Pointer to the ITBasicCallControl interface for the consultation call.

[in] fSync

Indicates whether the call should be conferenced synchronously (VARIANT_TRUE) or asynchronously (VARIANT_FALSE). See Connect for additional explanation.

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 pCall parameter is not a valid pointer.
E_INVALIDARG	The pCall parameter does not point to a valid interface.
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.

The consultation call (pCall) is created by ITAddress::CreateCall. The connection is completed by calling the Finish method. Please see Create a Simple Conference for an example of using this method.

If the consultation call is not in the CONNECTED state when Conference 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, Conference will fail with E_INVALIDARG.

Requirements

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