Partager via

lineSetupTransfer (Compact 2013)

  • Article

3/26/2014

This function initiates a transfer of the call specified by the hCall parameter. It establishes a consultation call, lphConsultCall, on which the party can be dialed that can become the destination of the transfer. The application acquires owner privilege to the lphConsultCall parameter.

Syntax

LONG WINAPI lineSetupTransfer(
  HCALL hCall,
  LPHCALL lphConsultCall,
  LPLINECALLPARAMS const lpCallParams 
);

Parameters

  • hCall
    Handle of the call to be transferred. The application must be an owner of the call. The call state of hCall must be connected.

  • lphConsultCall
    Pointer to an HCALL handle. This location is then loaded with a handle identifying the temporary consultation call. When setting up a call for transfer, a consultation call is automatically allocated that enables the lineDial function to dial the address associated with the new transfer destination of the call. The originating party can carry on a conversation over this consultation call prior to completing the transfer. The call state of hConsultCall is not applicable.

    This transfer procedure may not be valid for some line devices. The application may need to ignore the new consultation call and unhold an existing held call (using the lineUnhold function) to identify the destination of the transfer. On switches that support cross-address call transfer, the consultation call can exist on a different address than the call to be transferred. It may also be necessary that the consultation call be set up as an entirely new call, by lineMakeCall, to the destination of the transfer. Which forms of transfer are available are specified in the call's address capabilities.

  • lpCallParams
    Pointer to call parameters to be used when establishing the consultation call. This parameter is one or more of the LINECALLPARAMFLAGS constants. This parameter can be set to NULL if no special call setup parameters are desired.

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_BEARERMODEUNAVAIL

The bearer mode is unavailable.

LINEERR_INVALRATE

The rate is invalid.

LINEERR_CALLUNAVAIL

The call is unavailable.

LINEERR_NOMEM

Not enough memory is available.

LINEERR_INUSE

The line is in use.

LINEERR_NOTOWNER

The application is not an owner of this call.

LINEERR_INVALADDRESSMODE

The address mode is invalid.

LINEERR_OPERATIONFAILED

The operation failed.

LINEERR_INVALBEARERMODE

The bearer mode is invalid.

LINEERR_OPERATIONUNAVAIL

The operation is unavailable.

LINEERR_INVALCALLHANDLE

The handle to the call is invalid.

LINEERR_RATEUNAVAIL

The rate is unavailable.

LINEERR_INVALCALLPARAMS

The call parameters are invalid.

LINEERR_RESOURCEUNAVAIL

The resources are unavailable.

LINEERR_INVALCALLSTATE

The call state of hCall is something other than connected.

LINEERR_STRUCTURETOOSMALL

The structure is too small.

LINEERR_INVALLINESTATE

The line state is invalid.

LINEERR_UNINITIALIZED

A parameter is uninitialized.

LINEERR_INVALMEDIAMODE

The media mode is invalid.

LINEERR_USERUSERINFOTOOBIG

The user-user information is too big.

LINEERR_INVALPOINTER

The pointer is invalid.

Remarks

The lineSetupTransfer function sets up the transfer of the call specified by hCall. The setup phase of a transfer establishes a consultation call that enables the application to send the address of the destination (the party to be transferred to) to the switch, while the call to be transferred is kept on hold. This new call is referred to as a consultation call (hConsultCall) and can be dropped or otherwise manipulated independently of the original call.

When the consultation call has reached the dial tone call state, the application can proceed transferring the call either by dialing the destination address and tracking its progress, or by unholding an existing call. The transfer of the original call to the selected destination is completed using the lineCompleteTransfer function.

While the consultation call exists, the original call typically transitions to the onholdPendingTransfer state. The application may be able to toggle between the consultation call and the original call by using the lineSwapHold function. A consultation call can be canceled by invoking lineDrop on it. After dropping a consultation call, the original call typically transitions back to the connected state. If the call state of the original call is onHoldPendingTransfer, the lineUnhold function can be used to recover the call. In this case, the call state of the consultation call is set to idle.

The application can also transfer calls in a single step, without having to deal with the intervening consultation call, by using the lineBlindTransfer function.

Requirements

Header

tapi.h

Library

TAPI32.dll

See Also

Reference

TAPI Line Device Functions
lineBlindTransfer
lineCompleteTransfer
lineDial
lineDrop
lineMakeCall
lineSwapHold
lineUnhold
LINE_REPLY