Sign in Join
FPDoc Onlineexperiment

TXMLConfig.GetValue function

Member of TXMLConfigpublicIn unit Laz2_XMLCfg

Gets the value from the DOM node at the specified path in the XML configuration file.

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: Int64): Int64
function GetValue(const APath: string; ADefault: Boolean): Boolean
procedure GetValue(const APath: string; const ADefault; out AResult; 
 const APTypeInfo: PTypeInfo)
procedure GetValue(const APath: string; ADefault: Int64; out AResult; 
 const APTypeInfo: PTypeInfo)
procedure GetValue(const APath: string; out AResult; 
 const APTypeInfo: PTypeInfo)
procedure GetValue(const APath: string; out ARect: TRect; 
 const ADefault: TRect)

Arguments

APath

Path to locate in the Document.

ADefault

Default value used when the DOM node has no content.

AResult

Returns the value for a set or enumeration element as the type specified in APTypeInfo.

APTypeInfo

Pointer to the RTTI type information for the value.

ARect

TRect with the value for the DOM node.

Function result

Value for the Node at the specified path.

Description

GetValue is an overloaded function used to get the value stored in a DOM node at the path specified in APath. Overloaded variants are provided to return String, Integer, Int64, Boolean, and TRect data types. Other variants allow the arguments to be represented as various data types including untyped constants.

APath contain the path specifier that represents the hierarchy of elements and attributes in Document where the value is stored. See TXMLConfig Path Syntax for details about path specifiers.

ADefault contains the default value returned when the DOM node does not have any content representing a value.

ARect is the TRect output parameter used to return the value in the overloaded method.

Use GetExtendedValue to get the value for a DOM node as an Extended (or Float) data type.

See also

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