JVCL Help:TJvSearchFiles.Search

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

Search in JVCL Help

 
Search in all projects
 

Summary

Searches for files or directories.


Pascal

 functionSearch: Boolean;


Return Value

Returns False if an error occurred or the user did abort the operation, otherwise returns True.


Description

Call Search to start a search operation. If soSearchFiles is included in Options, then Search will search for files. If soSearchDirs is included in Options, then Search will search for directories.
Use RootDirectory to specify the start directory for the search. Use DirOption to specify whether Search must only scan the start directory or must also include its sub-directories.
Each time a valid directory - as specified by DirParams - is found, the component updates TotalDirectories and TotalFileSize, triggers the OnFindDirectory event and adds the directory name to Directories (if soOwnerData isn't included in Options).
Each time a valid file - as specified by FileParams - is found, the component updates TotalFiles and TotalFileSize, triggers the OnFindFile event and adds the file name to Files (if soOwnerData isn't included in Options).
Eventually Search will end with result False, if an error occurred or the user did abort the operation, or otherwise with result True.


See Also

TJvSearchFiles.Abort, TJvSearchFiles.Searching


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