FileTools - Maple Programming Help

Online Help

All Products    Maple    MapleSim


Home : Support : Online Help : Programming : Input and Output : File Manipulation : FileTools : FileTools/AtEndOfFile

FileTools

  

AtEndOfFile

  

determine if the current position of a file is at the end

 

Calling Sequence

Parameters

Description

Examples

Calling Sequence

AtEndOfFile(file)

Parameters

file

-

filename or file descriptor

Description

• 

The AtEndOfFile(file) command returns true if and only if the end of a STREAM file has been reached during a read operation. Otherwise, AtEndOfFile(file) returns false.

• 

The end of file must actually have been encountered. For example, requesting  Read to read 20 bytes when only 19 remain in the file results in a subsequent AtEndOfFile call returning true. When the ReadLine function reads the last line of a file, it does not encounter the end of file; the next call to ReadLine reads the end of file.

• 

If file does not refer to an open file, AtEndOfFile raises an error.

Examples

FileTools[Text][Open]testFile:

FileTools[AtEndOfFile]testFile

false

(1)

FileTools[Position]testFile,∞:

FileTools[Text][ReadCharacter]testFile:

FileTools[AtEndOfFile]testFile

true

(2)

FileTools[Text][Close]testFile:

See Also

file

file_types

FileTools

FileTools[Binary][Read]

FileTools[Position]

FileTools[Text][Close]

FileTools[Text][Open]

FileTools[Text][ReadCharacter]

FileTools[Text][ReadLine]

IO_errors

iostatus