Sign in Join
FPDoc Onlineexperiment

TConfigStorage.SetValue procedure

Member of TConfigStoragepublicIn unit LazConfigStorage

Stores a value at the specified path in the configuration storage.

Declaration

pascal
procedure SetValue(const APath: string; const AValue: string)
procedure SetValue(const APath: string; AValue: Integer)
procedure SetValue(const APath: string; AValue: Boolean)
procedure SetValue(const APath: string; const AValue: TRect)
procedure SetValue(const APath: string; const AValue: TPoint)
procedure SetValue(const APath: string; const AValue: TStrings)

Arguments

APath

Node path (relative to CurrentBasePath) where the specified value is stored.

AValue

Value stored for the specified node path.

Description

SetValue is an overloaded method in TConfigStorage used to store the value specified in the AValue argument to the node path in APath. The overloaded variants allow AValue to be specified using String, Integer, Boolean, TRect, or TPoint types.

APath contains the node path where the value is stored in the storage mechanism. SetValue calls the ExtendPath method to include the value in CurrentBasePath prior to the specified node path.

The SetFullPathValue method is called to store AValue to the underlying storage mechanism. Overloads for TRect and TPoint are decomposed and stored as the members values for the types. For TRect: Left, Top, Right, and Bottom are stored. For TPoint: X and Y are stored.

Use GetValue to read a stored value for a specified node path.

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