FileSetPos - Revision history

Lettify: Portuguese version indexed

2023-12-20T20:03:30Z

Portuguese version indexed

← Older revision		Revision as of 20:03, 20 December 2023
Line 33:		Line 33:
	==See Also==		==See Also==
	{{File functions}}		{{File functions}}
			[[pt-br:fileSetPos]]

Strix: add oop syntax

2015-01-02T20:37:23Z

add oop syntax

← Older revision		Revision as of 20:37, 2 January 2015
Line 8:		Line 8:
	int fileSetPos ( file theFile, int offset )		int fileSetPos ( file theFile, int offset )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|\|[[file]]:setPos\|pos\|fileGetPos}}

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

Myonlake at 10:54, 3 December 2013

2013-12-03T10:54:29Z

← Older revision		Revision as of 10:54, 3 December 2013
Line 11:		Line 11:
	===Required Arguments===		===Required Arguments===
	*'''theFile:''' The file handle of which you want to change the read/write position.		*'''theFile:''' The file handle of which you want to change the read/write position.
	*'''offset:''' The new position. This is the number of bytes from the beginning of the file. If this value is larger than the file size, it is limited to 52,428,800 (50 MB).		*'''offset:''' The new position. This is the number of bytes from the beginning of the file. If this value is larger than the file size, it is limited to 52,428,800 bytes (50 MB).

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

Myonlake: format file size

2013-12-03T10:54:16Z

format file size

← Older revision		Revision as of 10:54, 3 December 2013
Line 11:		Line 11:
	===Required Arguments===		===Required Arguments===
	*'''theFile:''' The file handle of which you want to change the read/write position.		*'''theFile:''' The file handle of which you want to change the read/write position.
	*'''offset:''' The new position. This is the number of bytes from the beginning of the file. If this value is larger than the file size, it is limited to ~~52428800~~.		*'''offset:''' The new position. This is the number of bytes from the beginning of the file. If this value is larger than the file size, it is limited to 52,428,800 (50 MB).

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

Ccw at 20:54, 1 December 2013

2013-12-01T20:54:32Z

← Older revision		Revision as of 20:54, 1 December 2013
Line 11:		Line 11:
	===Required Arguments===		===Required Arguments===
	*'''theFile:''' The file handle of which you want to change the read/write position.		*'''theFile:''' The file handle of which you want to change the read/write position.
	*'''offset:''' The new position. This is the number of bytes from the beginning of the file.		*'''offset:''' The new position. This is the number of bytes from the beginning of the file. If this value is larger than the file size, it is limited to 52428800.

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

Ccw at 12:01, 13 September 2011

2011-09-13T12:01:10Z

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

	Sets the current read/write position in the file.		Sets the current read/write position in the file.

Arc at 22:22, 25 November 2007

2007-11-25T22:22:51Z

← Older revision		Revision as of 22:22, 25 November 2007
Line 26:		Line 26:
	fileClose(hFile) -- close the file		fileClose(hFile) -- close the file
	else		else
	outputConsole("Unable to open ~~file~~.dat")		outputConsole("Unable to open test.dat")
	end		end
	</syntaxhighlight>		</syntaxhighlight>

Arc at 10:54, 24 November 2007

2007-11-24T10:54:10Z

← Older revision		Revision as of 10:54, 24 November 2007
Line 1:		Line 1:
	~~number fileSetPos ( file, number offset )~~		__NOTOC__
			{{Server function}}

	Sets the current read/write position in the file. ~~Offset~~ is number of bytes from beginning of file. Returns where the offset was actually set at. Ie if it was ~~above~~ end of file, it will be set at the end of the file.		Sets the current read/write position in the file.

			==Syntax==
			<syntaxhighlight lang="lua">
			int fileSetPos ( file theFile, int offset )
			</syntaxhighlight>

			===Required Arguments===
			*'''theFile:''' The file handle of which you want to change the read/write position.
			*'''offset:''' The new position. This is the number of bytes from the beginning of the file.

			===Returns===
			Returns where the offset was actually set at. I.e. if '''offset''' was past the end of the file, it will be set at the end of the file, and this position will be returned. Returns ''false'' in case of failure (e.g. the specified file handle is invalid).

			==Example==
			This example opens a binary file and prints the value of the byte at position 8 to the console.
			<syntaxhighlight lang="lua">
			local hFile = fileOpen("test.dat") -- attempt to open the file
			if hFile then -- check if it succeeded
			fileSetPos(hFile, 8) -- set the read/write position
			local readByte = fileRead(hFile, 1) -- read one byte from this position
			outputConsole("Byte at position 8 = " .. string.byte(readByte)) -- output it
			fileClose(hFile) -- close the file
			else
			outputConsole("Unable to open file.dat")
			end
			</syntaxhighlight>

			==See Also==
			{{File functions}}

ChrML: New page: number fileSetPos ( file, number offset ) Sets the current read/write position in the file. Offset is number of bytes from beginning of file. Returns where the offset was actually set at....

2007-11-23T01:18:27Z

New page: number fileSetPos ( file, number offset ) Sets the current read/write position in the file. Offset is number of bytes from beginning of file. Returns where the offset was actually set at....

New page

number fileSetPos ( file, number offset )

Sets the current read/write position in the file. Offset is number of bytes from beginning of file. Returns where the offset was actually set at. Ie if it was above end of file, it will be set at the end of the file.