Share via

TSPI_lineHold (Compact 2013)

  • Article

3/26/2014

This function places the specified call on hold.

Syntax

LONG TSPIAPI TSPI_lineHold(
  DRV_REQUESTID dwRequestID,  
  HDRVCALL hdCall 
);

Parameters

  • dwRequestID
    Identifier of the asynchronous request.
  • hdCall
    Service provider's handle to the call to be placed on hold. The call state of hdCall can be connected.

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

The call on hold is temporarily disconnected, allowing TAPI to use the line device for making or answering other calls. TSPI_lineHold performs a hard hold of the specified call, as opposed to a consultation call. A call on hard hold typically cannot be transferred or included in a conference call, whereas a consultation call can. Consultation calls are initiated using the TSPI_lineSetupTransfer, TSPI_lineSetupConference, or TSPI_linePrepareAddToConference function.

After a call is successfully placed on hold, the call state typically transitions to onHold. A held call is retrieved through the TSPI_lineUnhold function. While a call is on hold, the service provider can send LINE_CALLSTATE messages about state changes of the held call. For example, if the held party hangs up, the call state can transition to disconnected, and the service provider can send a LINE_CALLSTATE message indicating the new state.

Requirements

Header

tspi.h

Library

CellTSP.dll

See Also

Reference

TSPI Line Device Functions
TSPI_lineSetupConference
TSPI_lineSetupTransfer
TSPI_lineUnhold