TSPI_lineRemoveFromConference (Compact 2013)

3/26/2014

This function removes the specified call from the conference call to which it currently belongs. The remaining calls in the conference call are unaffected.

Syntax

LONG TSPIAPI TSPI_lineRemoveFromConference(
  DRV_REQUESTID dwRequestID, 
  HDRVCALL hdCall 
);

Parameters

• dwRequestID
  Identifier of the asynchronous request.

• hdCall
  Handle to the call to be removed from the conference. The call state of hdCall can be conferenced.

Return Value

Returns dwRequestID, or an error number if an error occurs. The lResult actual parameter of the corresponding ASYNC_COMPLETION is zero if the function succeeds, or an error number if an error occurs. The following table shows the return values for this function.

Value	Description
LINEERR_INVALCALLHANDLE	The handle to the call is invalid.
LINEERR_OPERATIONUNAVAIL	The operation is unavailable.
LINEERR_INVALCALLSTATE	The call state is invalid.
LINEERR_OPERATIONFAILED	The operation failed.
LINEERR_NOMEM	Not enough memory is available.
LINEERR_RESOURCEUNAVAIL	The resource is unavailable.

Remarks

This operation removes a party that currently belongs to a conference call. After the call has been successfully removed, it may be possible to further manipulate it using its handle. The availability of this operation and its result are likely to be limited in many implementations. For example, in many implementations, only the most recently added party can be removed from a conference, and the removed call may be automatically dropped (becomes idle). The service provider indicates its capabilities in the LINEDEVCAPS structure with regard to the available effects of removing a call from a conference.

If the removal of a participant from a conference is supported, the service provider must indicate in the dwRemoveFromConfState member in the LINEADDRESSCAPS structure the call state to which the call transitions after it is removed from the conference.

Requirements

Header	tspi.h
Library	CellTSP.dll

See Also

Reference

TSPI Line Device Functions
TSPI_lineAddToConference
TSPI_lineGetDevCaps
TSPI_lineSetupConference