TIndexDefs.FindIndexForFields function

Member of TIndexDefspublicIn unit DB

Find index definition based on field names.

Declaration

pascal

function FindIndexForFields(const Fields: string): TIndexDef

Arguments

Fields

Fieldlist to look for.

Function result

TIndexDef instance with fieldlist matching Fields.

Description

FindIndexForFields searches in the list of indexes for an index whose Fields property matches the list of fields in Fields. If it finds an index definition, then it returns the found instance.

Errors

If no matching definition is found, an exception is raised. This is different from other Find functionality, where Find usually returns Nil if nothing is found.