FireDAC.Comp.Client.TFDCustomCommand.Active

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

property Active: Boolean read GetActive write SetActive default False;

C++

__property bool Active = {read=GetActive, write=SetActive, default=0};

Properties

Type Visibility Source Unit Parent
property public
FireDAC.Comp.Client.pas
FireDAC.Comp.Client.hpp
FireDAC.Comp.Client TFDCustomCommand

Description

Gets or sets the active status of the command.

Set Active to True to execute the SQL command and return the cursor. After that, the State equals csOpen and you can fetch rows from the current cursor using the Fetch method. Setting Active to True, calls the Open method.

Set Active to False to close the current command cursor. After that, State equals csPrepared. Setting Active to False, calls the Close method. To close all command cursors (if the command returns multiple result sets), use the CloseAll method.

See Also