FireDAC.Comp.Client.TFDCustomEventAlerter
Delphi
TFDCustomEventAlerter = class (TFDComponent, IFDPhysEventHandler)
C++
class PASCALIMPLEMENTATION TFDCustomEventAlerter : public Firedac::Stan::Intf::TFDComponent
Properties
| Type | Visibility | Source | Unit | Parent |
|---|---|---|---|---|
| class | public | FireDAC.Comp.Client.pas FireDAC.Comp.Client.hpp |
FireDAC.Comp.Client | FireDAC.Comp.Client |
Description
The class responsible for handling the database event notifications.
Use the TFDCustomEventAlerter class to handle the database event notifications. The kind and general behavior of the events is DBMS specific, but TFDCustomEventAlerter provides a unified way for handling them.
To start receiving the event alerts, fill in the Names property with required event names. Set Options.Kind to the event alerter kind or leave it empty to use the default alerter. Specify OnAlert event handler, which will be fired when an event occurs, and set Active to True or call the Register method. To stop receiving the event alerts, set Active to False or call Unregister.
For details about what FireDAC drivers support the event alerters and how to use them, see the Database Alerts chapter. This class hides some of the properties, allowing the descendant classes to control the properties' visibility. End users should use TFDEventAlerter.