FileIsEOF - Revision history

Lettify: Portuguese version indexed

2023-12-20T19:04:05Z

Portuguese version indexed

2016-10-22T16:57:53Z

>> Fix CLuaFileDefs OOP typo

2015-01-02T20:38:32Z

add oop syntax

2014-01-28T16:35:27Z

← Older revision		Revision as of 16:35, 28 January 2014
Line 3:		Line 3:

	Checks if the file position is at the end of the file.		Checks if the file position is at the end of the file.
			{{Note\|Due to underlying C API restrictions this function may return false until an attempt to read further than the end of the file is made.}}

	==Syntax==		==Syntax==

2011-09-13T12:00:21Z

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

	Checks if the file position is at the end of the file.		Checks if the file position is at the end of the file.

2007-11-24T10:42:06Z

← Older revision		Revision as of 10:42, 24 November 2007
Line 1:		Line 1:
	~~bool fileIsEOF ( file )~~		__NOTOC__
			{{Server function}}

	Returns true if the file read/~~write~~ position is at the ~~end~~ of the file.		Checks if the file position is at the end of the file.

			==Syntax==
			<syntaxhighlight lang="lua">
			bool fileIsEOF ( file theFile )
			</syntaxhighlight>

			===Required Arguments===
			*'''theFile:''' A handle to the file you wish to check.

			===Returns===
			Returns ''true'' if the file position of the specified file is at the end of the file, ''false'' otherwise.

			==Example==
			This example opens the file test.txt and outputs its contents to the console.
			<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) -- ... and output them to the console
			end
			fileClose(hFile) -- close the file once we're done with it
			else
			outputConsole("Unable to open test.txt")
			end
			</syntaxhighlight>

			When you open a file, its file position is set to the beginning of the file. Each call to [[fileRead]] or [[fileWrite]] moves the position ahead by the amount of bytes that were read/written. This way, by using ''fileIsEOF'' you can check if you've passed through the whole file.

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

2007-11-23T01:16:55Z

New page: bool fileIsEOF ( file ) Returns true if the file read/write position is at the end of the file.

New page

bool fileIsEOF ( file )

Returns true if the file read/write position is at the end of the file.