JCL Help:TDelTreeProgress

From Project JEDI Wiki
Jump to navigationJump to search


Summary

Progress callback routine for the DelTreeEx function.


Pascal

 TDelTreeProgress = function (const FileName: string; Attr: DWORD): Boolean;


Parameters

Parameters Description
FileName The name of the file that is about to be deleted.
Attr The attributes of the file. See GetFileAttributes in the Platform SDK for a full list of attribute flags.


Return Value

If you return True DelTreeEx deletes the specified file and continues with the next one. If you return False DeltreeEx aborts immediately.


Description

TDelTreeProgress is the function signature for the Progress parameter of the DelTreeEx function. This function is called just before the file is deleted. You can use this callback routine to display progress to the user. To allow DelTreeEx to continue deleting files return True, to abort the deletion return False.


See Also

DelTreeEx


About

Unit

JclFileUtils


Donator

John C Molyneux


Notes

Returning False will abort the entire deletion process, not just for the specified file only.


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