Pair: fileSetPos

Returns the current read/write position in the given file.

OOP Syntax Help! I don't understand this!

• Method:file:getPos(...)
• Variable: .pos

Syntax

​int|false fileGetPos ( ​file theFile )

Required arguments

• theFile: The file handle you wish to get the position of.

Returns

Returns the file position if successful, or false if an error occured (e.g. an invalid handle was passed).

• int|false: result

Code Examples

Example 1 Example 2 (OOP)

shared

This example opens the file test.txt and outputs its contents and current read position 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 .. "Current Position: " .. fileGetPos(hFile)) -- ... and output them to the console and outputs the current read position
    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 and current read position 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 .. "Current Position: " .. hFile.pos) -- ... and output them to the console and outputs the current read position
    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
• fileGetHashNew
• fileGetPath
• fileGetPos
• fileGetSize
• fileIsEOF
• fileOpen
• fileRead
• fileRename
• fileSetPos
• fileWrite

File Elements

• file

Reference

• Scripting Functions