CFile Class


The CFile class provides file reading and writing operations. Normally, this class is designed for use with binary-mode files but may also be used for text files. Note that the lua I/O library also provides many functions for file I/O (Input and Output).

Usage

Construction

Object = new_file()

Object = CFile:new()

Destruction

Object:delete()

Properties

This class contains 3 enumerated value for use by the Seek method:

nBegin

The file offset is moved relative to the beginning of the file.

nCurrent

The file offset is moved relative to the current position.

nEnd

The file offset is moved relative to the end of the file.

Creator Functions

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

new_file

Creates a new instance of a CFile object, like CFile:new.

new_fileopen

Opens a file in the specified mode and returns a new CFile object for it. This combines the new_file creator and the Open method.

Construction and Destruction - Class Methods

new

Creates a new instance of a CFile object, like new_file.

delete

Deletes the instance of the CFile object.

Operations

Close

Closes the file.

FilePos

Returns the current file position.

Flush

Commits data in the operating system buffer to the file.

GetPath

Returns the name of the file.

Open

Opens the file. Also see File Access Modes.

Printf

Writes formatted text to the file.

Read

Reads a value or table of values of specified pixel type from a binary file.

ReadBswap

Reads a value or table of values of specified pixel type from a binary file. The values are automatically byte-swapped.

Seek

Resets the file position to a given location.

Write

Writes a value or table to a binary file using the specified pixel type.

WriteBswap

Writes a value or table to a binary file using the specified pixel type. The values are automatically byte-swapped before being written to the file.

Related Topics

Printf

lua I/O library

CFindFiles class


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