TSPI_lineSwapHold function (tspi.h)

Article
02/22/2024

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

Syntax

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 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. 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

Requirement	Value
Target Platform	Windows
Header	tspi.h