Checks if the file position is at the end of the file.

Caution

Due to underlying C API restrictions this function may return false until an attempt to read further than the end of the file is made.

Note

When you open a file, its file position is set to the beginning of the file. Each call to fileRead or fileWrite moves the position ahead by the amount of bytes that were read/written. This way, by using fileIsEOF you can check if you've passed through the whole file.

OOP Syntax Help! I don't understand this!

• Method: file:isEOF(...)
• Variable: .eof

Syntax

bool fileIsEOF ( file theFile )

Required Arguments

• theFile: A handle to the file you wish to check.

Returns

• bool: result

Returns true if the file position of the specified file is at the end of the file, false otherwise.

Code Examples

Example 1 Example 2 (OOP)

shared

This example opens the file test.txt and outputs its contents to the console.

local hFile = fileOpen("test.txt", true)       -- attempt to open the file (read only)
if hFile then                                  -- check if it was successfully opened
    local buffer
    while not fileIsEOF(hFile) do              -- as long as we're not at the end of the file...
        buffer = fileRead(hFile, 500)          -- ... read the next 500 bytes...
        outputConsole(buffer)                  -- ... and output them to the console
    end
    fileClose(hFile)                           -- close the file once we're done with it
else
    outputConsole("Unable to open test.txt")
end

shared

OOP Required

This example opens the file test.txt and outputs its contents to the console.

local hFile = File("test.txt", true)       -- attempt to open the file (read only)
if (hFile) then                                  -- check if it was successfully opened
    local buffer
    while not hFile.eof do              -- as long as we're not at the end of the file...
        buffer = hFile:read(500)          -- ... read the next 500 bytes...
        outputConsole(buffer)                  -- ... and output them to the console
    end
    hFile:close()                           -- close the file once we're done with it
else
    outputConsole("Unable to open test.txt")
end

See Also

File Functions

• fileClose
• fileCopy
• fileCreate
• fileDelete
• fileExists
• fileFlush
• fileGetContents
• fileGetHash
• fileGetPath
• fileGetPos
• fileGetSize
• fileIsEOF
• fileRead
• fileOpen
• fileRename
• fileSetPos
• fileWrite

File Elements

• file

Reference

• Scripting Functions