ThbTapiLine.CompleteTransfer
Unit: hbTapi

Completes the call's transfer to a destination party. The desination is specified by the ConsultCall parameter. This consultation call has to be in the connected state.

A transfer can be initiated using the SetupTransfer function or if the user initiated the process using the phone set. If the BuildConference parameter is set to True, a new conference call (with both calls as its members) will be created and returned as the result value. If the BuildConference parameter is set to False, the call will be transfered and the states of both calls will turn to idle. In this case the functions result is nil.

This method is designed for the expert user who wants to select the participating calls by his own. You are also able to use the call's CompleteTransfer method which selects the consultance resp. primary call automatically.

Declaration

function CompleteTransfer(ConsultCall: ThbTapiCall; BuildConference: Boolean): ThbTapiCall;

Remarks

The BuidConference feature is only available if the LINETRANSFERMODE_CONFERENCE bit flag is set in the ThbTapiAddress.Caps.TransferModes property.

Using this method causes the TAPI lineCompleteTransfer function to be called. This function works in an asynchronous manner. See the chapter "The Synchronous / Asynchronous Model" and the ThbTapiLine.Options.SyncMode property to read more about the handling of asynchronous functions.

Errors

Using this function may cause an EhbTapiError exception . Possible errors are:

LINEERR_INVALCALLHANDLE, LINEERR_NOTOWNER, LINEERR_INVALCALLSTATE, LINEERR_OPERATIONUNAVAIL, LINEERR_INVALCONSULTCALLHANDLE, LINEERR_OPERATIONFAILED, LINEERR_INVALTRANSFERMODE, LINEERR_RESOURCEUNAVAIL, LINEERR_INVALPOINTER, LINEERR_UNINITIALIZED, LINEERR_NOMEM.

See Also

ThbTapiLine.PrepareAddToConference, Establish a Conference Call, ThbTapiCall.ConferenceCall