Sign in Join
FPDoc Onlineexperiment

TStoredValues.IndexOf function

Member of TStoredValuespublicIn unit PropertyStorage

Gets the ordinal position in Items for the collection item with the specified name.

Declaration

pascal
function IndexOf(const AName: string): Integer

Arguments

AName

Name of the collection item to locate in the method.

Function result

Ordinal position for the collection item with the given name, or -1 when not found.

Description

IndexOf iterates over the values in the Items property to locate the TStoredValue instance with a Name property that matches the value in AName. AnsiCompareText is called to perform a case-insensitive comparison which also ignores accents in the characters.

The return value contains the ordinal position in Items where the value in AName was located, or -1 when a collection item is not found using the specified name.

See also

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.