CFindFiles Class


The CFindFiles class provides file searching capability. This class is used to get a list of files in a folder that match a file name template.

Usage

Construction

Object = CFindFiles:new()

Object = CFindFiles:new( sFolder )

Object = CFindFiles:new( sFolder, Template )

Destruction

Object:delete()

Related Global Functions

FindFiles

Returns a Lua table containing the names of the files in a folder, optionally matching a file name template. This function uses the CFindFile class internally but does not provide access to it.

Class Methods

Construction

new

Creates a new instance of a CFindFiles object.

delete

Deletes the instance of the CFindFiles object.

Accessing Properties

GetPath

Returns the current path saved by the last call to Next().

Operations

GetTable

Returns a Lua table containing the list of all files found in the folder using the specified file name templte.

Open

Opens access to file searching using a specified folder and filename template.

Start

Begins iteration over file names. Used with Next.

Next

Returns the next file found.

Close

Closes the current object's access to the file system, but does not delete the CFileFind object.

Related Topics

Script Classes

GetFileList

CFile class

CFileDlg class