FileRead - Revision history

FileEX: Undo revision 79983 by Tracer (talk) Feature reverted again

2024-08-14T19:21:20Z

Undo revision 79983 by Tracer (talk) Feature reverted again

← Older revision		Revision as of 19:21, 14 August 2024
Line 8:		Line 8:
	string fileRead ( file theFile, int count )		string fileRead ( file theFile, int count )
	</syntaxhighlight>		</syntaxhighlight>

	~~{{Added feature/item\|1.6.1\|1.6.0\|22650\|~~
	~~<syntaxhighlight lang="lua">~~
	~~string fileRead ( string filePath )~~
	~~</syntaxhighlight>~~
	}}
	{{OOP\|\|[[file]]:read}}		{{OOP\|\|[[file]]:read}}

Line 19:		Line 13:
	*'''theFile:''' A handle to the file you wish to read from. Use [[fileOpen]] to obtain this handle.		*'''theFile:''' A handle to the file you wish to read from. Use [[fileOpen]] to obtain this handle.
	*'''count:''' The number of bytes you wish to read.		*'''count:''' The number of bytes you wish to read.
	~~{{Added feature/item\|1.6.1\|1.6.0\|22650\|~~
	*'''filePath:''' Path to the file you want to read
	}}

	===Returns===		===Returns===
Line 27:		Line 18:

	==Example==		==Example==
	~~<section name="Shared" class="both" show="true">~~
	This example opens the file test.txt and outputs its contents to the console.		This example opens the file test.txt and outputs its contents to the console.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
Line 45:		Line 35:
	end)		end)
	</syntaxhighlight>		</syntaxhighlight>
	~~</section>~~

	~~<section name="Server" class="server" show="true">~~		[[fileOpen]] sets the read/write position to the beginning of the file.
	~~This example reads file from path and prints its content~~ to the ~~console~~		[[fileGetSize]] gets the total size in bytes of given file.
	~~<syntaxhighlight lang="lua">~~
	~~addCommandHandler('readFile', function(player, cmd,~~ file)
	~~if not~~ file ~~then~~
	~~outputChatBox('You need to provide a path!', player, 255,0,0)~~
	~~return~~
	~~end~~
	~~outputChatBox(fileRead(file), player)~~
	~~end)~~
	~~</syntaxhighlight>~~
	~~</section>~~

	==See Also==		==See Also==
	{{File functions}}		{{File functions}}
	[[pt-br:fileRead]]		[[pt-br:fileRead]]

Tracer: Undo revision 79715 - Feature reintroduced

2024-08-02T13:26:36Z

Undo revision 79715 - Feature reintroduced

← Older revision		Revision as of 13:26, 2 August 2024
Line 8:		Line 8:
	string fileRead ( file theFile, int count )		string fileRead ( file theFile, int count )
	</syntaxhighlight>		</syntaxhighlight>

			{{Added feature/item\|1.6.1\|1.6.0\|22650\|
			<syntaxhighlight lang="lua">
			string fileRead ( string filePath )
			</syntaxhighlight>
			}}
	{{OOP\|\|[[file]]:read}}		{{OOP\|\|[[file]]:read}}

Line 13:		Line 19:
	*'''theFile:''' A handle to the file you wish to read from. Use [[fileOpen]] to obtain this handle.		*'''theFile:''' A handle to the file you wish to read from. Use [[fileOpen]] to obtain this handle.
	*'''count:''' The number of bytes you wish to read.		*'''count:''' The number of bytes you wish to read.
			{{Added feature/item\|1.6.1\|1.6.0\|22650\|
			*'''filePath:''' Path to the file you want to read
			}}

	===Returns===		===Returns===
Line 18:		Line 27:

	==Example==		==Example==
			<section name="Shared" class="both" show="true">
	This example opens the file test.txt and outputs its contents to the console.		This example opens the file test.txt and outputs its contents to the console.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
Line 35:		Line 45:
	end)		end)
	</syntaxhighlight>		</syntaxhighlight>
			</section>

	~~[[fileOpen]] sets the read/write position~~ to the ~~beginning of the~~ file.		<section name="Server" class="server" show="true">
	~~[[fileGetSize]] gets the total size in bytes of given~~ file.		This example reads file from path and prints its content to the console
			<syntaxhighlight lang="lua">
			addCommandHandler('readFile', function(player, cmd, file)
			if not file then
			outputChatBox('You need to provide a path!', player, 255,0,0)
			return
			end
			outputChatBox(fileRead(file), player)
			end)
			</syntaxhighlight>
			</section>

	==See Also==		==See Also==
	{{File functions}}		{{File functions}}
	[[pt-br:fileRead]]		[[pt-br:fileRead]]

FileEX: Undo revision 79650 by Tracer (talk)

2024-06-30T09:49:37Z

Undo revision 79650 by Tracer (talk)

← Older revision		Revision as of 09:49, 30 June 2024
Line 8:		Line 8:
	string fileRead ( file theFile, int count )		string fileRead ( file theFile, int count )
	</syntaxhighlight>		</syntaxhighlight>

	~~{{Added feature/item\|1.6.1\|1.6.0\|22560\|~~
	~~<syntaxhighlight lang="lua">~~
	~~string fileRead ( string filePath )~~
	~~</syntaxhighlight>~~
	}}
	{{OOP\|\|[[file]]:read}}		{{OOP\|\|[[file]]:read}}

Line 19:		Line 13:
	*'''theFile:''' A handle to the file you wish to read from. Use [[fileOpen]] to obtain this handle.		*'''theFile:''' A handle to the file you wish to read from. Use [[fileOpen]] to obtain this handle.
	*'''count:''' The number of bytes you wish to read.		*'''count:''' The number of bytes you wish to read.
	~~{{Added feature/item\|1.6.1\|1.6.0\|22560\|~~
	*'''filePath:''' Path to the file you want to read
	}}

	===Returns===		===Returns===
Line 27:		Line 18:

	==Example==		==Example==
	~~<section name="Shared" class="both" show="true">~~
	This example opens the file test.txt and outputs its contents to the console.		This example opens the file test.txt and outputs its contents to the console.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
Line 45:		Line 35:
	end)		end)
	</syntaxhighlight>		</syntaxhighlight>
	~~</section>~~

	~~<section name="Server" class="server" show="true">~~		[[fileOpen]] sets the read/write position to the beginning of the file.
	~~This example reads file from path and prints its content~~ to the ~~console~~		[[fileGetSize]] gets the total size in bytes of given file.
	~~<syntaxhighlight lang="lua">~~
	~~addCommandHandler('readFile', function(player, cmd,~~ file)
	~~if not~~ file ~~then~~
	~~outputChatBox('You need to provide a path!', player, 255,0,0)~~
	~~return~~
	~~end~~
	~~outputChatBox(fileRead(file), player)~~
	~~end)~~
	~~</syntaxhighlight>~~
	~~</section>~~

	==See Also==		==See Also==
	{{File functions}}		{{File functions}}
	[[pt-br:fileRead]]		[[pt-br:fileRead]]

Tracer at 16:28, 24 June 2024

2024-06-24T16:28:22Z

← Older revision		Revision as of 16:28, 24 June 2024
Line 8:		Line 8:
	string fileRead ( file theFile, int count )		string fileRead ( file theFile, int count )
	</syntaxhighlight>		</syntaxhighlight>

			{{Added feature/item\|1.6.1\|1.6.0\|22560\|
			<syntaxhighlight lang="lua">
			string fileRead ( string filePath )
			</syntaxhighlight>
			}}
	{{OOP\|\|[[file]]:read}}		{{OOP\|\|[[file]]:read}}

Line 13:		Line 19:
	*'''theFile:''' A handle to the file you wish to read from. Use [[fileOpen]] to obtain this handle.		*'''theFile:''' A handle to the file you wish to read from. Use [[fileOpen]] to obtain this handle.
	*'''count:''' The number of bytes you wish to read.		*'''count:''' The number of bytes you wish to read.
			{{Added feature/item\|1.6.1\|1.6.0\|22560\|
			*'''filePath:''' Path to the file you want to read
			}}

	===Returns===		===Returns===
Line 18:		Line 27:

	==Example==		==Example==
			<section name="Shared" class="both" show="true">
	This example opens the file test.txt and outputs its contents to the console.		This example opens the file test.txt and outputs its contents to the console.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
Line 35:		Line 45:
	end)		end)
	</syntaxhighlight>		</syntaxhighlight>
			</section>

	~~[[fileOpen]] sets the read/write position~~ to the ~~beginning of the~~ file.		<section name="Server" class="server" show="true">
	~~[[fileGetSize]] gets the total size in bytes of given~~ file.		This example reads file from path and prints its content to the console
			<syntaxhighlight lang="lua">
			addCommandHandler('readFile', function(player, cmd, file)
			if not file then
			outputChatBox('You need to provide a path!', player, 255,0,0)
			return
			end
			outputChatBox(fileRead(file), player)
			end)
			</syntaxhighlight>
			</section>

	==See Also==		==See Also==
	{{File functions}}		{{File functions}}
	[[pt-br:fileRead]]		[[pt-br:fileRead]]

Lettify: Portuguese version indexed

2023-12-20T19:37:15Z

Portuguese version indexed

← Older revision		Revision as of 19:37, 20 December 2023
Line 41:		Line 41:
	==See Also==		==See Also==
	{{File functions}}		{{File functions}}
			[[pt-br:fileRead]]

Myonlake at 12:16, 16 April 2022

2022-04-16T12:16:49Z

← Older revision		Revision as of 12:16, 16 April 2022
Line 23:		Line 23:
	local file = fileOpen(path) -- attempt to open the file		local file = fileOpen(path) -- attempt to open the file
	if not file then		if not file then
	return false -- stop function on ~~failture~~		return false -- stop function on failure
	end		end
	local count = fileGetSize(file) -- get file's total size		local count = fileGetSize(file) -- get file's total size

JeViCo: /* Example */

2018-09-16T06:28:22Z

Example

← Older revision		Revision as of 06:28, 16 September 2018
Line 31:		Line 31:
	end		end

	addCommandHandler("~~readFile~~",function(cmd,fileName) -- add command to test this function		addCommandHandler("readfile",function(cmd,fileName) -- add command to test this function
	readFile(fileName) -- execute the function		readFile(fileName) -- execute the function
	end)		end)

JeViCo: /* Example */

2018-09-16T06:26:41Z

Example

← Older revision		Revision as of 06:26, 16 September 2018
Line 37:		Line 37:

	[[fileOpen]] sets the read/write position to the beginning of the file.		[[fileOpen]] sets the read/write position to the beginning of the file.
	[[fileGetSize]] gets the total size in bytes of given file		[[fileGetSize]] gets the total size in bytes of given file.

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

JeViCo: /* Example */

2018-09-16T06:26:10Z

Example

← Older revision		Revision as of 06:26, 16 September 2018
Line 20:		Line 20:
	This example opens the file test.txt and outputs its contents to the console.		This example opens the file test.txt and outputs its contents to the console.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	local ~~hFile~~ = fileOpen(~~"test.txt"~~) -- attempt to open the file		function readFile(path)
	if ~~hFile then -- check if it was successfully opened~~		local file = fileOpen(path) -- attempt to open the file
	~~local buffer~~		if not file then
	~~while~~ not ~~fileIsEOF(hFile) do -- as long as we're not at the end of the~~ file~~...~~		return false -- stop function on failture
	~~buffer = fileRead(hFile, 500)~~ -- ~~... read the next 500 bytes...~~
	~~outputConsole(buffer) -- ... and output them to the console~~
	end		end
	fileClose(~~hFile~~) -- close the file once we're done with it		local count = fileGetSize(file) -- get file's total size
	~~else~~		local data = fileRead(file, count) -- read whole file
	outputConsole(~~"Unable to open test.txt"~~)		fileClose(file) -- close the file once we're done with it
			outputConsole(data) -- output code in console
	end		end

			addCommandHandler("readFile",function(cmd,fileName) -- add command to test this function
			readFile(fileName) -- execute the function
			end)
	</syntaxhighlight>		</syntaxhighlight>

	[[fileOpen]] sets the read/write position to the beginning of the file. Each call of fileRead will read 500 bytes from the current position, and advance the position over the same amount. If we get near the end of the file and there are less than 500 bytes left to read, all that's left will be read and [[~~fileIsEOF~~]] ~~will return ''true''.~~		[[fileOpen]] sets the read/write position to the beginning of the file.
			[[fileGetSize]] gets the total size in bytes of given file

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

Strix: add oop syntax

2015-01-02T20:38:56Z

add oop syntax

← Older revision		Revision as of 20:38, 2 January 2015
Line 8:		Line 8:
	string fileRead ( file theFile, int count )		string fileRead ( file theFile, int count )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|\|[[file]]:read}}

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