[Overview][Constants][Types][Classes][Procedures and functions][Index] Reference for unit 'LazConfigStorage' (#lazutils)

TConfigStorage.GetValue

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

Declaration

Source position: lazconfigstorage.pas line 55

public function TConfigStorage.GetValue(

  const APath: string;

  const ADefault: string

):string;

function TConfigStorage.GetValue(

  const APath: string;

  ADefault: Integer

):Integer;

function TConfigStorage.GetValue(

  const APath: string;

  ADefault: Boolean

):Boolean;

procedure TConfigStorage.GetValue(

  const APath: string;

  out ARect: TRect;

  const ADefault: TRect

);

procedure TConfigStorage.GetValue(

  const APath: string;

  out APoint: TPoint;

  const ADefault: TPoint

);

procedure TConfigStorage.GetValue(

  const APath: string;

  const List: TStrings

);

Arguments

APath

  

Path in the configuration storage relative to CurrentBasePath where the value is stored.

ADefault

  

Default value used when a value is not found at the specified path.

Function result

Returns the value stored at the specified path.

Arguments

APath

  

Path in the configuration storage relative to CurrentBasePath where the value is stored.

ADefault

  

Default value used when a value is not found at the specified path.

Arguments

APath

  

Path in the configuration storage relative to CurrentBasePath where the value is stored.

ADefault

  

Default value used when a value is not found at the specified path.

Arguments

APath

  

Path in the configuration storage relative to CurrentBasePath where the value is stored.

ARect

  

Returns the value read from the configuration storage as a TRect type.

ADefault

  

Default value used when a value is not found at the specified path.

Arguments

APath

  

Path in the configuration storage relative to CurrentBasePath where the value is stored.

APoint

  

Returns the value read from the configuration storage as a TPoint type.

ADefault

  

Default value used when a value is not found at the specified path.

Arguments

APath

  

Path in the configuration storage relative to CurrentBasePath where the value is stored.

List

  

Returns the value read from the configuration storage as a TStrings type.

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:

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.


Version 4.0 Generated 2025-05-03 Home