FireDAC.Comp.Client.TFDEventAlerter.Active

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

property Active;

C++

__property Active = {default=0};

Properties

Type Visibility Source Unit Parent
property published
FireDAC.Comp.Client.pas
FireDAC.Comp.Client.hpp
FireDAC.Comp.Client TFDEventAlerter

Description

Controls the event registration state of the event alerter.

FireDAC.Comp.Client.TFDEventAlerter.Active inherits from FireDAC.Comp.Client.TFDCustomEventAlerter.Active. All content below this line refers to FireDAC.Comp.Client.TFDCustomEventAlerter.Active.

Controls the event registration state of the event alerter.

Use the Active property to set or check when an event alerter has registered the FireDAC.Comp.Client.TFDCustomEventAlerter.Names events with a DBMS and is waiting for events. 

Set the Active property to True to register the events with a DBMS and start the incoming events. If a FireDAC DBMS driver supports some event alerters, the event alerter kind must be explicitly assigned to the Options.Kind property. 

Set the property to False to stop the events processing.

See Also