JVCL Help:TJvCustomAppStorage.CheckDeletePathByVersion

From Project JEDI Wiki
Jump to navigationJump to search
JEDI Visual Component Library Help

Search in JVCL Help

 
Search in all projects
 

Summary

Conditionally deletes the specified folder/value and any sub folders.


Pascal

 procedureCheckDeletePathByVersion(constPath: string; VersionNumber: Integer; DeleteIfNotEqual: Boolean = False; WriteVersionNumber: Boolean = True; constVersionName: string = cVersionCheckName);


Parameters

Parameters Description
const Path: string Path (relative to the current path) of the sub tree to delete.
VersionNumber: Integer The value which is compared.
DeleteIfNotEqual: Boolean = False Indicates when to delete the subtree. If DeleteIfNotEqual is set to True, the subtree is delete when the stored value is not equal to parameter VersionNumber. If DeleteIfNotEqual is set to False, the subtree is deleted when the stored value is less than VersionNumber.
WriteVersionNumber: Boolean = True Determines if the Value of VersionNumber should be stored in the subtree after the check.
const VersionName: string = cVersionCheckName The name of the stored version number in the path


Description

CheckDeletePathByVersion gives the possibility to delete a folder out of the storage depending on a stored value named "Version".


See Also

TJvCustomAppStorage.DeleteSubTree,TJvCustomAppStorage.CheckDeletePathByVersion


About

Contribute to this help topic

This documentation wiki is based on the collaborative effort of Project JEDI users. Your edits are welcome in order to improve documentation quality: edit this page