TConfigStorage.SetDeleteValue

Updates the value for the specified node path, or deletes it when it contains a default value.

Declaration

Source position: lazconfigstorage.pas line 64

public procedure TConfigStorage.SetDeleteValue(

const APath: string;

const AValue: string;

const DefValue: string

); procedure TConfigStorage.SetDeleteValue(

const APath: string;

AValue: Integer;

DefValue: Integer

); procedure TConfigStorage.SetDeleteValue(

const APath: string;

AValue: Boolean;

DefValue: Boolean

); procedure TConfigStorage.SetDeleteValue(

const APath: string;

const AValue: TRect;

const DefValue: TRect

); procedure TConfigStorage.SetDeleteValue(

const APath: string;

const AValue: TPoint;

const DefValue: TPoint

);

Arguments

`APath`		Path to the node value updated or removed in the method.
`AValue`		Value stored in the specified node.
`DefValue`		Default value which triggers removal of the node when it is the same as AValue.

Arguments

`APath`		Path to the node value updated or removed in the method.
`AValue`		Value stored in the specified node.
`DefValue`		Default value which triggers removal of the node when it is the same as AValue.

Arguments

`APath`		Path to the node value updated or removed in the method.
`AValue`		Value stored in the specified node.
`DefValue`		Default value which triggers removal of the node when it is the same as AValue.

Arguments

`APath`		Path to the node value updated or removed in the method.
`AValue`		Value stored in the specified node.
`DefValue`		Default value which triggers removal of the node when it is the same as AValue.

Arguments

`APath`		Path to the node value updated or removed in the method.
`AValue`		Value stored in the specified node.
`DefValue`		Default value which triggers removal of the node when it is the same as AValue.

Description

SetDeleteValue is an overloaded method in TConfigStorage. The variants allow the method to be used to store a value using either a String, Integer, Boolean, TRect, or TPoint type in the AValue argument.

APath is the path to the node where the value is stored. It is specified with a value relative to the CurrentBasePath property. ExtendPath is called to insert CurrentBasePath at the start of the node path.

DefValue contains the value treated as the default value for the node path. The overloaded variants use the same type as specified in the AValue argument.

SetDeleteValue calls the SetDeleteFullPathValue method to update or remove the value at the specified path. When DefValue is equal to AValue, the node path in APath to be removed from the configuration storage.

Version 4.0

Generated 2025-05-03

Home