FireDAC.Comp.Client.TFDCustomEventAlerter.Signal

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

procedure Signal(const AEvent: String; const AArgument: Variant);

C++

void __fastcall Signal(const System::UnicodeString AEvent, const System::Variant &AArgument);

Properties

Type Visibility Source Unit Parent
procedure
function
public
FireDAC.Comp.Client.pas
FireDAC.Comp.Client.hpp
FireDAC.Comp.Client TFDCustomEventAlerter

Description

Fires a DBMS event.

Use the Signal method to fire a DBMS event. To fire an event, the event alerter must be registered with a DBMS.

AEvent is the name of the event to fire.

AArgument represents the optional arguments for the event. Use an array of Variant if more than one argument must be specified. Otherwise, use nil.

Example

FDEventAlerter1.Names.Text := 'Customers';
FDEventAlerter1.Register;
FDEventAlerter1.Signal('Customers', 123);

See Also