TNamedIniCollection.IndexOfUserData function

Member of TNamedIniCollectionpublicIn unit IniCol

Search for an item based on it's UserData property.

Declaration

pascal

function IndexOfUserData(UserData: TObject): Integer

Arguments

UserData

UserData to search for.

Function result

Index of found item, or -1 if none was found.

Description

IndexOfUserData searches the list of items and returns the index of the item which has UserData in its UserData property. If no such item exists, -1 is returned.

Note that the (linear) search starts at the last element and works it's way back to the first.

Errors

If no item exists, -1 is returned.