FireDAC.Comp.Client.TFDCustomEventAlerter.OnAlert

提供: RAD Studio API Documentation
移動先: 案内検索

Delphi

property OnAlert: TFDEventAlerterEvent read FOnAlert write FOnAlert;

C++

__property TFDEventAlerterEvent OnAlert = {read=FOnAlert, write=FOnAlert};

プロパティ

種類 可視性 ソース ユニット
event public
FireDAC.Comp.Client.pas
FireDAC.Comp.Client.hpp
FireDAC.Comp.Client TFDCustomEventAlerter

説明

このイベントは、DBMS イベントが発生した際に、発生します。

OnAlert イベント ハンドラを使用すると、FireDAC.Comp.Client.TFDCustomEventAlerter.Names プロパティで指定されている DBMS イベントの 1 つが発生した際に発生する、イベント ハンドラを指定することができます。イベント通知を受信し始めるには、Register メソッドや Active プロパティを使用して、イベントが登録されていなければなりません。イベント ハンドラは、独自のイベント アラータ スレッド内で発生(False)、もしくは、メインのアプリケーション スレッドで発生し(True)、それは、Options.Synchronize オプションによって変わります。

イベント ハンドラは、3 つの引数を受け取ります:

  • ASender--イベント アラータの参照。
  • AEventName--イベント名を指定。
  • AArgument--イベントに対する追加引数を指定。これら引数は、DBMS やアプリケーションによって変わります。引数が指定されていない場合、Null または Unassigned 値が渡されます。引数が 1 つだけ指定されている場合、それはスカラー バリアント値で、そうでなければ、それは値のバリアント配列となります。

 
 procedure TForm1.FDEventAlerter1Alert(ASender: TFDCustomEventAlerter;
   const AEventName: String; const AArgument: Variant);
 begin
   if CompareText(AEventName, 'Customers') = 0 then
     qryCustomers.Refresh
   else if CompareText(AEventName, 'Orders') = 0 then
     qryOrders.Refresh;
 end;

関連項目