ThbTapiCall.CompleteTransfer
Unit: hbTapi

Completes a call transfer to a destination party.

A transfer can be initiated using the method or if the user starts the process using the phone set. The call can be either the consultation call or the call that has called the SetupTransfer method and has to be transfered.

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 uses an automatism to select the corresponding call. If you need to select the participating call by your own, you are able to use the line's CompleteTransfer method.

Declaration

function CompleteTransfer(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

ThbTapiCall.SetupTransfer, Establish a Conference Call