X file:seek

Available since: Gideros 2011.6
Class: file

Description

Sets and gets the file position, measured from the beginning of the file to the position given by offset plus a base specified by the string whence. <syntaxhighlight lang="lua"> (number) = file:seek(whence, offset) </source>

Possible values for whence:

• "set": base is position 0 (beginning of the file)
• "cur": base is current position
• "end": base is end of file

In case of success, function seek returns the final file position, measured in bytes from the beginning of the file. If this function fails, it returns nil, plus a string describing the error.

Therefore:

• file:seek() returns the current file position, without changing it
• file:seek("set") sets the position to the beginning of the file (and returns 0)
• file:seek("end") sets the position to the end of the file, and returns its size

Parameters

whence: (string) setting the base point for offset optional (default = "cur")
offset: (number) offset to set position to optional (default = 0)

Return values

Returns (number) the position in file measured in bytes from the beginning of the file

---

• file

• X file:close
• X file:flush
• X file:lines
• X file:read
• X file:seek
• X file:write

---

---

• Main Page
• Lua API
• Main API
• Plugins