Platform SDK: TAPI

TSPI_lineSwapHold

The TSPI_lineSwapHold function swaps the specified active call with the specified call on consultation hold.

LONG TSPIAPI TSPI_lineSwapHold(
  DRV_REQUESTID dwRequestID,  
  HDRVCALL hdActiveCall,  
  HDRVCALL hdHeldCall     
);

Parameters

dwRequestID
The identifier of the asynchronous request.
hdActiveCall
The handle to the call to be swapped with the call on consultation hold. The call state of hdActiveCall can be connected.
hdHeldCall
The handle to the consultation call. The call state of hdHeldCall can be onHoldPendingTransfer, onHoldPendingConference, or onHold.

Return Values

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. Possible return values are as follows:

LINEERR_INVALCALLHANDLE, LINEERR_OPERATIONUNAVAIL, LINEERR_INVALCALLSTATE, LINEERR_OPERATIONFAILED, LINEERR_NOMEM, LINEERR_RESOURCEUNAVAIL.

Remarks

The service provider must send LINE_CALLSTATE messages for the call transitions.

Requirements

  Windows NT/2000: Requires Windows NT 4.0 SP3 or later.
  Windows 95/98: Requires Windows 95 or later.
  Version: Requires TAPI 1.3 or later.
  Header: Declared in Tspi.h.

See Also

ASYNC_COMPLETION, LINE_CALLSTATE, TSPI_lineSetupConference, TSPI_lineSetupTransfer