FireDAC.Comp.Client.TFDCustomConnection.Offlined

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

property Offlined: Boolean read FOfflined write SetOfflined default False;

C++

__property bool Offlined = {read=FOfflined, write=SetOfflined, default=0};

Properties

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

Description

Gets or sets the connection's offline status.

Set Offlined to True to switch the connection, commands, and datasets associated with it to the offline mode. In offline mode the connection to the DBMS is closed, but the datasets remain open. 

If a dataset associated with this connection object is active and not all records are fetched from the DBMS cursor, then depending on the FetchOptions.AutoFetchAll value, the following actions are performed:

  • afAll (default mode)--the dataset fetches all the records from the cursor and goes to offline mode.
  • afTruncate--the dataset truncates the result set and goes to offline mode.
  • afDisable-- an exception is raised.

If the application tries to perform, on a command or a dataset's objects, any operation requiring a DBMS connection, then if ResourceOptions.AutoConnect is True, the connection will automatically establish a connection to the DBMS. This is the default mode. If ResourceOptions.AutoConnect is False, then the connection object will raise an exception. 

Set Offlined to False to establish a connection with the DBMS and switch to online mode.

See Also