ThbTapiAddress.ChangeForwardList

Changes the forwarding list of the specified address. When an originating address is forwarded, the specified incoming calls for that address are deflected to the other number by the switch. This function provides a combination of forward and do-not-disturb features. This function can also cancel forwarding currently in effect.

A successful forwarding indicates only that the request has been accepted by the service provider, not that forwarding is set up at the switch. An OnAddressState (forwarding) event provides confirmation for forwarding having been set up at the switch.

procedure TForm1.Button3Click(Sender: TObject);
var l: ThbTapiForwardList;
begin
  l := ThbTapiForwardList.Create;
  try
    l.AddEntry(LINEFORWARDMODE_UNCOND, '', 0, '102');
    hbTapiLine1.Addresses[0].ChangeforwardList(l, 3, hbTapiLine1.CallParams);
  finally
    l.free;
  end;
end;

Forwarding of the address(es) remains in effect until this function is called again. The most recent forwarding list replaces the old one. Forwarding can be cancelled by specifying a nil pointer as ForwardList. If an empty destination address is specified for an entry in the forwarding list, the operation acts as a do-not-disturb.

procedure TForm1.Button8Click(Sender: TObject);
begin
  hbTapiLine1.Addresses[0].ChangeForwardList(nil, 0, nil);
end;

Declaration

procedure ChangeForwardList(ForwardList: ThbTapiForwardList; NumRingsNoAnswer: DWORD; CallParams: ThbTapiCallParams);

Remarks

In TAPI terms the lineForward function is called. 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_INVALLINEHANDLE, LINEERR_NOMEM, LINEERR_INVALADDRESSID, LINEERR_OPERATIONUNAVAIL, LINEERR_INVALADDRESS, LINEERR_OPERATIONFAILED, LINEERR_INVALCOUNTRYCODE, LINEERR_RESOURCEUNAVAIL, LINEERR_INVALPOINTER, LINEERR_STRUCTURETOOSMALL, LINEERR_INVALPARAM, LINEERR_UNINITIALIZED.

See Also

ThbTapiAddress.ForwardList | ForwardTo