ScanFiles

Icetips Utilities Documentation 11/14/2010

File Search Class: ScanFiles

Previous Top Next

Prototype:

(<String pDir>,<String pWC>, Long pAttrib=FF_:NORMAL, BYTE pCountOnly=False,BYTE pFreeFiles=True),Long,Proc

[pDir]

Omitable Folder to scan for files. If omitted all folders in SELF.Directories will be processed.

[pWC]

Omittable wildcard string. If omitted, *.* is used. If SELF.FileFilter is specified it is used if this parameter is omitted or empty.

pAttrib

Optional attribute for files to scan. Defaults to FF_:Normal. See DIRECTORY in the Clarion help for more information about attribute equates.

pCountOnly

Optional parameter to indicate if the method should only count files and not load them into the SELF.Files queue.

pFreeFiles

Optional parameter to indicate if the method should free the SELF.Files queue. It defaults to True to preserve backward compatibility.

Returns

Returns number of files scanned

This method scans for files with the provided parameters and either counts them, or adds them to the SELF.Files queue. Before it is called, the ScanDirectories must be called to load the directories. It is called from CountFilesInDirectories to count files.

Example:

ITF ITFileSearchClass

Code

ITS.ScanDirectories()

ITS.ScanFiles()