Sign in Join
FPDoc Onlineexperiment

TFPHashList.Rename function

Member of TFPHashListpublicIn unit Contnrs

Rename a key.

Declaration

pascal
function Rename(const AOldName: RawByteString; 
 const ANewName: RawByteString): SizeInt

Arguments

AOldName

Key to rename.

ANewName

New name of key.

Function result

New position in the list.

Description

Rename renames key AOldname to ANewName. The hash value is recomputed and the item is moved in the list to it's new position.

Errors

If an item with ANewName already exists, an exception will be raised.

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