CFileList Class Description

The CFileList class opens and processes a Mira file list. A file list is a text document containing a set of file names, one per line. In the Mira user interface, file lists are saved in .axf type files, but this class can open a file list from any file type. To use the CFileList, create the object using new or new_filelist, then iterate over the files using Next. The CFileDlg and CFindFiles classes have some similar capabilties.

Usage

Construction

Object = new_filelist()

Object = new_filelist( sFileName )

Object = new_filelist( CFileList )

Object = CFileList:new()

Object = CFileList:new( sFileName )

Object = CFileList:new( CFileList )

Destruction

Object:delete()

Creation - Non-class Functions

This function is normally used to create a new CFileList object as an alternative to the class-based new method.

new_filelist

Creates a new instance of a CFileList object.

Construction and Destruction - Class Methods

new

Creates a new instance of a CFileList object. Various constructors are available.

delete

Deletes the instance of the CFileList object.

Operations

Count

Returns the number of files in the file list.

Open

Opens access to a file list object when a CFileList object already exists.

Start

Begins iteration over file names. Used with Next.

Next

Returns the next file in the file list.

Close

Closes access to the file list, but does not delete the CFileList object.

Related Topics

Contents, Directory Functions, CFileDlg class, CFindFiles class, Script Classes, GetFileList, CFile


Mira Pro x64 Script User's Guide, Copyright Ⓒ 2023 Mirametrics, Inc. All Rights Reserved.