FireDAC.Comp.DataSet.TFDIndexes.FindIndexForFields

• Up to Parent: TFDIndexes

[–] Properties Type: function Visibility: public Source:

FireDAC.Comp.DataSet.pas

FireDAC.Comp.DataSet.hpp

Unit: FireDAC.Comp.DataSet Parent: TFDIndexes

Delphi

function FindIndexForFields(const AFields: String;
ARequiredOptions: TFDSortOptions = [];
AProhibitedOptions: TFDSortOptions = []): TFDIndex;

C++

TFDIndex* __fastcall FindIndexForFields(const System::UnicodeString AFields, Firedac::Stan::Intf::TFDSortOptions ARequiredOptions = Firedac::Stan::Intf::TFDSortOptions() , Firedac::Stan::Intf::TFDSortOptions AProhibitedOptions = Firedac::Stan::Intf::TFDSortOptions() );

Description

Finds an existing TFDIndex object by sorting fields and options.

Use the FindIndex method to find a view by sorting fields and options. If the view is not found, FindIndexForFields returns nil.

The matched view must have fields starting from AFields. The fields can include more fields than AFields. Also, all ARequiredOptions options must be included into Options, while no AProhibitedOptions option must be included into Options.

See Also

• FireDAC.Comp.DataSet.TFDIndex.Options
• FireDAC.Comp.DataSet.TFDIndexes.FindIndex