FireDAC.Comp.DataSet.TFDDataSet.Offline

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

procedure Offline;

C++

void __fastcall Offline();

Properties

Type Visibility Source Unit Parent
procedure
function
public
FireDAC.Comp.DataSet.pas
FireDAC.Comp.DataSet.hpp
FireDAC.Comp.DataSet TFDDataSet

Description

Sets the dataset to offline mode.

The Offline method call disconnects the dataset from the DBMS, but does not close it. After this call no more cursors are accessible. As a result, the dataset will not fetch any more records from the cursor, SourceEOF will be True, and a command will be unprepared. 

If ResourceOptions.AutoFetchAll is True, then before entering into offline mode, the dataset fetches all the remaining records from the current cursor. If it is False and not all records are fetched, then an exception is raised. Applications can fetch all the dataset records explicitly by calling the FetchAll method. 

In most cases there is no need to explicitly call the Offline method. It is implicitly used by the TFDCustomConnection.Offline method to set the connection and all the associated datasets to offline mode. 

The Release method is similar to the Offline method, but it does not unprepare the command.

See Also