Sign in Join
FPDoc Onlineexperiment

TXMLConfig.SetDeleteValue procedure

Member of TXMLConfigpublicIn unit Laz2_XMLCfg

Updates or removes the value stored at the specified path.

Declaration

pascal
procedure SetDeleteValue(const APath: string; const AValue: string; 
 const DefValue: string)
procedure SetDeleteValue(const APath: string; AValue: Int64; 
 DefValue: Int64)
procedure SetDeleteValue(const APath: string; AValue: Boolean; 
 DefValue: Boolean)
procedure SetDeleteValue(const APath: string; const AValue: TRect; 
 const DefValue: TRect)
procedure SetDeleteValue(const APath: string; const AValue; 
 const DefValue; const APTypeInfo: PTypeInfo)
procedure SetDeleteValue(const APath: string; const AValue; 
 DefValue: Int64; const APTypeInfo: PTypeInfo)
procedure SetDeleteValue(const APath: string; const AValue; 
 const APTypeInfo: PTypeInfo)

Arguments

APath

Path specifier for the value affected in the method.

AValue

Value to store at the specified path.

DefValue

Value which indicates the path should be removed instead of updated.

APTypeInfo

Pointer to the RTTI type information for the value / default value.

Description

SetDeleteValue is an overloaded method used to update or remove the node at the path specified in APath. The AValue and DefValue arguments determine whether the node is updated, or removed by calling DeleteValue. When AValue and DefValue are equal, this indicates the node has the default or unassigned value; DeleteValue is called to remove the node at APath. Otherwise, SetValue is called to store AValue to the specified node path.

The overloaded variants allow the AValue and DefValue arguments to contain various data types including: String, Int64, Boolean, TRect, or untyped constants.

See also

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