Sign in Join
FPDoc Onlineexperiment

TStoredValue.Restore procedure

Member of TStoredValuepublicIn unit PropertyStorage

Loads the value for the collection item from the storage container for the collection.

Declaration

pascal
procedure Restore; virtual

Description

Restore is a method used to load the Value for the collection item for the storage container for the collection.

Restore uses the existing Value as the default value for the restore operation. It is converted to a String when Value is defined as a Variant type.

KeyString contains the key used to XOR encode / decode values written to and read from the storage container for the collection. XOR encoding / decoding is not used when KeyString is an empty string ( '').

The default value is XOR encoded when needed. The StoredValues collection is used to access the Storage container and calls its ReadString method. The retrieved value is XOR decoded when needed.

Restore signals the OnRestore event handler (when assigned) to validate and/or modify the restored value.

See also

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