lineSwapHold (Compact 2013)

3/26/2014

This function swaps the specified active call with the specified call on consultation hold.

Syntax

LONG WINAPI lineSwapHold(
  HCALL hActiveCall,
  HCALL hHeldCall 
);

Parameters

• hActiveCall
  Handle to the active call. The application must be an owner of the call. The call state of hActiveCall must be connected.

• hHeldCall
  Handle to the consultation call. The application must be an owner of the call. The call state of hHeldCall can be onHoldPendingTransfer, onHoldPendingConference, or onHold.

Return Value

Returns a positive request identifier if the function is completed asynchronously, or a negative error number if an error occurs. The dwParam2 parameter of the corresponding LINE_REPLY message is zero if the function succeeds or it is a negative error number if an error occurs. The following table shows the return values for this function.

Value	Description
LINEERR_INVALCALLHANDLE	A call handle is invalid.
LINEERR_OPERATIONUNAVAIL	The operation is unavailable because this function is not supported by code division multiple access (CDMA). CDMA does not provide the necessary functionality to support the following TAPI functions: lineAccept lineAnswer lineClose lineCompleteTransfer lineDial lineDrop lineHold lineMakeCall linePark linePickup lineSwapHold Some cellular carriers provide equivalent functionality through the flash feature, which with TAPI 2.2 can be accessed with the lineGenerateDigits function. Because the exact flash sequences are controlled by the cellular providers, the application must be completely aware of the necessary codes implemented by the cellular providers.
LINEERR_INVALCALLSTATE	The call state is invalid.
LINEERR_OPERATIONFAILED	The operation failed.
LINEERR_NOMEM	Not enough memory is available.
LINEERR_RESOURCEUNAVAIL	The resources are unavailable.
LINEERR_NOTOWNER	The application is not an owner of this call.
LINEERR_UNINITIALIZED	A parameter is uninitialized.

Remarks

Swapping the active call with the call on consultation hold allows the application to alternate or toggle between these two calls. This is typical in call waiting.

Requirements

Header	tapi.h
Library	TAPI32.dll

See Also

Reference

TAPI Line Device Functions
LINE_REPLY