ThbTapiLine.SetupTransfer
Unit: hbTapi

The SetupTransfer method initiates a transfer of the call specified by the Call parameter. It establishes a consultation call, returned by this function, on which the party can be dialed that can become the destination of the transfer. The application acquires owner privilege to the new call.

This function is intended for the professional user, who needs to hand over more call paramerters than supported by ThbTapiLine.CallParams. Typically the simple variant ThbTapiCall.SetupTransfer method is used.

The CallParams parameter allows the application to specify how it wants the call to be set up. This structure allows the application to select elements such as the call's bearer mode, data rate, expected media mode, origination address, blocking of caller ID information, and dialing parameters. We recommend to use the ThbTapiCallParams object to generate the needed LINECALLPARAMS structure. The property ThbTapiLine.CallParams can be used also. If NIL is specified, a default 3.1 kHz voice call is established and an arbitrary origination address on the line is selected.

interface
uses hbTapi, tapi;

TForm1.Button1.Click(Sender: TObject);
begin
  try
    hbTapiLine1.CallParams.MediaMode := LINEMEDIAMODE_INTERACTIVEVOICE; // interactive voice call
    hbTapiLine1.SetupTransfer(ThbTapiLine1.Calls[0], ThbTapiLine1.CallParams.TapiData);
  except
    on EhbTapiError do
      MessageDlg('SetupTransfer failed!' + E.Message, mtInformation, [mbOk], 0);
  end;
end;

Declaration

function SetupTransfer(Call: ThbTapiCall; CallParams: PLINECALLPARAMS): ThbTapiCall;

Remarks

Please refer to the section "lineSetupTransfer" in TAPI's documentation for a more detailed information. This function works in an asynchronous manner. See the SyncMode property to read more about the handling of asynchronous functions.

Errors

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

LINEERR_BEARERMODEUNAVAIL, LINEERR_INVALRATE, LINEERR_CALLUNAVAIL, LINEERR_NOMEM, LINEERR_INUSE, LINEERR_NOTOWNER, LINEERR_INVALADDRESSMODE, LINEERR_OPERATIONFAILED, LINEERR_INVALBEARERMODE, LINEERR_OPERATIONUNAVAIL, LINEERR_INVALCALLHANDLE, LINEERR_RATEUNAVAIL, LINEERR_INVALCALLPARAMS, LINEERR_RESOURCEUNAVAIL, LINEERR_INVALCALLSTATE, LINEERR_STRUCTURETOOSMALL, LINEERR_INVALLINESTATE, LINEERR_UNINITIALIZED, LINEERR_INVALMEDIAMODE, LINEERR_USERUSERINFOTOOBIG, LINEERR_INVALPOINTER.

See Also

LINECALLPARAMS, ThbTapiCallParams