FileIsEOF

Determines whether the end of the file has been reached while reading it.

Method Signature

FileIsEOF(file=[boxfile])

Arguments

Argument

Type

Required

Description

Default

file

boxfile

true

The currently open file object

Examples

Simple usage syntax

Call fileIsEOF on a file object and save the result to a variable.

fileObj = fileOpen(expandPath('./file.txt');
isEndOfFile = fileIsEOF(fileObj);

Using fileIsEOF to loop over all lines of a text file

Simplified example of using fileIsEOF to determine when all lines have been read from a file. Error handling omitted for clarity.

// Error handling omitted for clarity.
// open a file for reading
fileObj = fileOpen( expandPath( "./file.txt" ), "read" );
// read each line until we read the end of the file.
// fileIsEOF(fileObj) == false until we've read in the last line.
while (!fileIsEOF( fileObj )) {
	lineContent = fileReadLine( fileObj );
	// do something with content of each line

}
// end of file reached, close the file handle
fileClose( fileObj );

Additional Examples

filePath = "/path/to/file.txt";
openFile = fileopen( filePath, "read" );
lines = [];
// IMPORTANT: must close file, use try/catch/finally to do so
try {
	// fileIsEOF(openFile) == false until we've read in the last line.
	while (!fileIsEoF( openFile )) {
		arrayAppend( lines, fileReadLine( openFile ) );
	}
} catch (any e) {
	rethrow;
}finally {
	fileClose( openFile );
}

PreviousFileInfo

NextFileMove

Last updated 1 month ago

Was this helpful?