FileGetPos: Difference between revisions
Jump to navigation
Jump to search
(New page: number fileGetPos ( file ) Returns the current read/write position in the given file.) |
No edit summary |
||
| Line 1: | Line 1: | ||
__NOTOC__ | |||
{{Server function}} | |||
Returns the current read/write position in the given file. | Returns the current read/write position in the given file. | ||
==Syntax== | |||
<syntaxhighlight lang="lua"> | |||
number fileGetPos ( file theFile ) | |||
</syntaxhighlight> | |||
===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). | |||
==Example== | |||
==See Also== | |||
{{File functions}} | |||
Revision as of 10:44, 24 November 2007
Returns the current read/write position in the given file.
Syntax
number 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).
Example
See Also
- fileClose
- fileCopy
- fileCreate
- fileDelete
- fileExists
- fileFlush
- fileGetPath
- fileGetPos
- fileGetSize
- fileIsEOF
- fileOpen
- fileRead
- fileRename
- fileSetPos
- fileWrite