Sign in Join
FPDoc Onlineexperiment

TSortedCollection.KeyOf function

Member of TSortedCollectionIn unit Objects

Return the key of an item.

Declaration

pascal
function KeyOf(Item: Pointer): Pointer; virtual

Description

KeyOf returns the key associated with Item. TSortedCollection returns the item itself as the key, descendent objects can override this method to calculate a (unique) key based on the item passed (such as hash values).

Keys are used to sort the objects, they are used to search and sort the items in the collection. If descendent types override this method then it allows possibly for faster search/sort methods based on keys rather than on the objects themselves.

Errors

None.

See also

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