FireDAC.Comp.Client.TFDCustomLocalSQL.OnGetDataSet

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

property OnGetDataSet: TFDGetDatasetEvent read FOnGetDataSet write FOnGetDataSet;

C++

__property TFDGetDatasetEvent OnGetDataSet = {read=FOnGetDataSet, write=FOnGetDataSet};

Properties

Type Visibility Source Unit Parent
event public
FireDAC.Comp.Client.pas
FireDAC.Comp.Client.hpp
FireDAC.Comp.Client TFDCustomLocalSQL

Description

The event that fires when the Local SQL engine looks for a dataset object.

Use the OnGetDataSet event handler to submit a dataset object by its name.

This event can be used to dynamically provide a dataset, without registering it first with the Local SQL engine. The value of the AName and ADataSet.Name arguments may be different. After returning a dataset, it will be registered in the DataSets collection under the AName argument value.

The event handler must return ADataSet, AAdapter, or both arguments assigned. For FireDAC datasets, only ADataSet can be assigned. For non-FireDAC datasets we recommend that you assign both arguments.

See Also