Difference between revisions of "File:Seek"
From GiderosMobile
(Created page with "__NOTOC__ '''Available since:''' Gideros 2011.6<br/> === Description === Sets and gets the file position, measured from the beginning of the file, to the position given by off...") |
|||
| (5 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| − | '''Available since:''' Gideros 2011.6<br/> | + | <languages /> |
| − | === Description === | + | '''<translate>Available since</translate>:''' Gideros 2011.6<br/> |
| − | 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, as follows: | + | '''<translate>Class</translate>:''' [[Special:MyLanguage/file|file]]<br/> |
| + | === <translate>Description</translate> === | ||
| + | <translate>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, as follows: | ||
"set": base is position 0 (beginning of the file); | "set": base is position 0 (beginning of the file); | ||
| Line 11: | Line 13: | ||
| − | The default value for whence is "cur", and for offset is 0. Therefore, the call file:seek() returns the current file position, without changing it; the call file:seek("set") sets the position to the beginning of the file (and returns 0); and the call file:seek("end") sets the position to the end of the file, and returns its size. | + | The default value for whence is "cur", and for offset is 0. Therefore, the call file:seek() returns the current file position, without changing it; the call file:seek("set") sets the position to the beginning of the file (and returns 0); and the call file:seek("end") sets the position to the end of the file, and returns its size.</translate> |
<source lang="lua"> | <source lang="lua"> | ||
| − | (number) | + | (number) = file:seek(whence,offset) |
</source> | </source> | ||
| − | '''whence | + | === <translate>Parameters</translate> === |
| − | '''offset | + | '''whence''': (string) <translate>setting the base point for offset</translate> '''optional'''<br/> |
| − | '''Returns''' (number) the position in file measured in bytes from the beginning of the file<br/> | + | '''offset''': (number) <translate>offset to set position to</translate> '''optional'''<br/> |
| + | === <translate>Return values</translate> === | ||
| + | '''<translate>Returns</translate>''' (number) <translate>the position in file measured in bytes from the beginning of the file</translate><br/> | ||
Latest revision as of 09:59, 3 September 2018
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, as follows:
"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.
The default value for whence is "cur", and for offset is 0. Therefore, the call file:seek() returns the current file position, without changing it; the call file:seek("set") sets the position to the beginning of the file (and returns 0); and the call file:seek("end") sets the position to the end of the file, and returns its size.
(number) = file:seek(whence,offset)
Parameters
whence: (string) setting the base point for offset optional
offset: (number) offset to set position to optional
Return values
Returns (number) the position in file measured in bytes from the beginning of the file
File usage
There are no pages that use this file.
