Sign in Join
FPDoc Onlineexperiment

TConfigStorage.GetValue function

Member of TConfigStoragepublicIn unit LazConfigStorage

Gets the value stored at the specified path relative to the base path in the configuration storage.

Declaration

pascal
function GetValue(const APath: string; const ADefault: string): string
function GetValue(const APath: string; ADefault: Integer): Integer
function GetValue(const APath: string; ADefault: Boolean): Boolean
procedure GetValue(const APath: string; out ARect: TRect; 
 const ADefault: TRect)
procedure GetValue(const APath: string; out APoint: TPoint; 
 const ADefault: TPoint)
procedure GetValue(const APath: string; const List: TStrings)

Description

GetValue is an overloaded method in TConfigStorage. The overloaded variants allow the value read from the specified path in the configuration storage to be returned as one of the following types:

  • String
  • Integer
  • Boolean
  • TRect (returned in the output parameter)
  • TPoint (returned in the output parameter)
  • TStrings (returned in the output parameter)

ADefault contains the default value returned if a value is not found in the storage for the specified path. The argument uses the same type as the return value for the overloaded methods.

GetValue calls GetFullPathValue after using ExtendPath to insert the value CurrentBasePath at the start of the value in APath. The value in ADefault is passed to GetFullPathValue as the default value.

An experiment, built from Lazarus main 2dfa93c66e of 10-22-2026. Not the official Lazarus documentation.