FileGetPos - Revision history

Lettify: Portuguese version indexed

2023-12-20T18:51:21Z

Portuguese version indexed

2014-12-28T18:08:23Z

add oop syntax

← Older revision		Revision as of 18:08, 28 December 2014
Line 6:		Line 6:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua"> int fileGetPos ( file theFile ) </syntaxhighlight>		<syntaxhighlight lang="lua"> int fileGetPos ( file theFile ) </syntaxhighlight>
			{{OOP\|\|[[file]]:getPos\|pos\|fileSetPos}}
	===Required Arguments===		===Required Arguments===
	*'''theFile:''' the file handle you wish to get the position of.		*'''theFile:''' the file handle you wish to get the position of.

2014-12-27T11:19:03Z

← Older revision		Revision as of 11:19, 27 December 2014
Line 5:		Line 5:

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua"> int fileGetPos ( file theFile~~, bool readOnly~~ ) </syntaxhighlight>		<syntaxhighlight lang="lua"> int fileGetPos ( file theFile ) </syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	*'''theFile:''' the file handle you wish to get the position of.		*'''theFile:''' the file handle you wish to get the position of.
	*'''readOnly:''' is file handled as read only.

	===Returns===		===Returns===

2014-12-27T08:08:33Z

Syntax

← Older revision		Revision as of 08:08, 27 December 2014
Line 5:		Line 5:

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua"> int fileGetPos ( file theFile ) </syntaxhighlight>		<syntaxhighlight lang="lua"> int fileGetPos ( file theFile, bool readOnly ) </syntaxhighlight>

	===Required Arguments===		===Required Arguments===

2014-12-27T08:08:17Z

Required Arguments

← Older revision		Revision as of 08:08, 27 December 2014
Line 9:		Line 9:
	===Required Arguments===		===Required Arguments===
	*'''theFile:''' the file handle you wish to get the position of.		*'''theFile:''' the file handle you wish to get the position of.
	*'''readOnly:'~~'' ''boolean~~'' is file handled as read only.		*'''readOnly:''' is file handled as read only.

	===Returns===		===Returns===

2014-12-27T08:08:02Z

Required Arguments

← Older revision		Revision as of 08:08, 27 December 2014
Line 9:		Line 9:
	===Required Arguments===		===Required Arguments===
	*'''theFile:''' the file handle you wish to get the position of.		*'''theFile:''' the file handle you wish to get the position of.
	*'''readOnly:''' is file handled as read only.		*'''readOnly:''' ''boolean'' is file handled as read only.

	===Returns===		===Returns===

2014-12-27T08:07:35Z

Required Arguments

← Older revision		Revision as of 08:07, 27 December 2014
Line 9:		Line 9:
	===Required Arguments===		===Required Arguments===
	*'''theFile:''' the file handle you wish to get the position of.		*'''theFile:''' the file handle you wish to get the position of.
			*'''readOnly:''' is file handled as read only.

	===Returns===		===Returns===

2012-08-31T21:56:30Z

← Older revision		Revision as of 21:56, 31 August 2012
Line 5:		Line 5:

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua"> int fileGetPos ( file theFile ) </syntaxhighlight>
	int fileGetPos ( file theFile )
	</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
Line 32:		Line 30:
	==See Also==		==See Also==
	{{File functions}}		{{File functions}}
	~~[[Category:Needs Example]]~~

2012-08-31T21:55:50Z

Example

← Older revision		Revision as of 21:55, 31 August 2012
Line 16:		Line 16:

	==Example==		==Example==
	<syntaxhighlight lang="lua">		This example opens the file test.txt and outputs its contents and current read position to the console.
	--~~TODO~~		<syntaxhighlight lang="lua">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
	</syntaxhighlight>		</syntaxhighlight>

2011-09-13T11:59:53Z

← Older revision		Revision as of 11:59, 13 September 2011
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server function}}		{{Server client function}}

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