FileGetContents - Revision history

CrosRoad95 at 05:24, 19 October 2024

2024-10-19T05:24:15Z

← Older revision		Revision as of 05:24, 19 October 2024
Line 29:		Line 29:

	if buffer then		if buffer then
	loadstring(buffer)()		loadstring(buffer)() -- This is just an example. You should avoid using loadstring. If you are dealing with configuration use json functions instead for security reasons.
	end		end
	</syntaxhighlight>		</syntaxhighlight>

FileEX at 09:49, 30 June 2024

2024-06-30T09:49:10Z

← Older revision		Revision as of 09:49, 30 June 2024
Line 3:		Line 3:

	{{Added feature/item\|1.6.1\|1.6.0\|21938\|		{{Added feature/item\|1.6.1\|1.6.0\|21938\|
	Reads the entire contents of the file, optionally verifies the read contents by computing and comparing the checksum with the expected one, and returns the content as string. The file cursor position is not modified by calls to this function.		Reads the entire contents of the file, optionally verifies the read contents by computing and comparing the checksum with the expected one, and returns the content as string. The file cursor position is not modified by calls to this function. File must be added in the [[meta.xml]].
	}}		}}

Line 16:		Line 16:
	===Required Arguments===		===Required Arguments===
	*'''theFile:''' A handle to the file you wish to get the contents from. Use [[fileOpen]] to obtain this handle.		*'''theFile:''' A handle to the file you wish to get the contents from. Use [[fileOpen]] to obtain this handle.
	*'''verifyContents:''' Set to true, to compare the computed and the expected checksum of the file content		*'''verifyContents:''' Set to true, to compare the computed and the expected checksum of the file content.

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

FileEX: Undo revision 79649 by Tracer (talk)

2024-06-30T09:47:22Z

Undo revision 79649 by Tracer (talk)

← Older revision		Revision as of 09:47, 30 June 2024
Line 12:		Line 12:
	nil\|string fileGetContents ( file theFile [ , bool verifyContents = true ] )		nil\|string fileGetContents ( file theFile [ , bool verifyContents = true ] )
	</syntaxhighlight>		</syntaxhighlight>

	~~{{Added feature/item\|1.6.1\|1.6.0\|22560\|~~
	~~<syntaxhighlight lang="lua">~~
	~~nil\|string fileGetContents ( string filePath [ , bool verifyContents = true ] )~~
	~~</syntaxhighlight>~~
	}}

	{{OOP\|\|[[file]]:getContents}}		{{OOP\|\|[[file]]:getContents}}

	===Required Arguments===		===Required Arguments===
	*'''theFile:''' A handle to the file you wish to get the contents from. Use [[fileOpen]] to obtain this handle.		*'''theFile:''' A handle to the file you wish to get the contents from. Use [[fileOpen]] to obtain this handle.

	~~{{Added feature/item\|1.6.1\|1.6.0\|22560\|~~
	*'''filePath:''' Path to a file you want to read
	}}
	*'''verifyContents:''' Set to true, to compare the computed and the expected checksum of the file content		*'''verifyContents:''' Set to true, to compare the computed and the expected checksum of the file content

Line 33:		Line 22:

	==Example==		==Example==
	~~<section name="Shared" class="both" show="true">~~
	This example opens the code.lua file, checks its contents, and then runs it.		This example opens the code.lua file, checks its contents, and then runs it.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
Line 44:		Line 32:
	end		end
	</syntaxhighlight>		</syntaxhighlight>
	~~</section>~~

	~~<section name="Shared" class="both" show="true">~~
	~~This example reads content from a requested model and sends it back to the client.~~
	~~<syntaxhighlight lang="lua">~~
	~~addEvent('onRequestModel', true)~~
	~~addEventHandler('onRequestModel', resourceRoot, function(path)~~
	~~triggerClientEvent(client, 'onSendModel', client, fileGetContents(path))~~
	~~end)~~
	~~</syntaxhighlight>~~
	~~</section>~~

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

	[[pt-br:fileGetContents]]		[[pt-br:fileGetContents]]

FileEX: Undo revision 79654 by Fernando187 (talk)

2024-06-30T09:47:08Z

Undo revision 79654 by Fernando187 (talk)

← Older revision		Revision as of 09:47, 30 June 2024
Line 3:		Line 3:

	{{Added feature/item\|1.6.1\|1.6.0\|21938\|		{{Added feature/item\|1.6.1\|1.6.0\|21938\|
	Reads the entire contents of the file, optionally verifies the read contents by computing and comparing the checksum with the expected one ~~(file must be in meta.xml)~~, and returns the content as string. The file cursor position is not modified by calls to this function.		Reads the entire contents of the file, optionally verifies the read contents by computing and comparing the checksum with the expected one, and returns the content as string. The file cursor position is not modified by calls to this function.
	}}		}}

Line 27:		Line 27:
	*'''filePath:''' Path to a file you want to read		*'''filePath:''' Path to a file you want to read
	}}		}}
	*'''verifyContents:''' Set to true, to compare the computed and the expected checksum of the file content ~~(file must be in meta.xml).~~		*'''verifyContents:''' Set to true, to compare the computed and the expected checksum of the file content

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

Fernando187: add (file must be in meta.xml)

2024-06-25T14:23:49Z

add (file must be in meta.xml)

← Older revision		Revision as of 14:23, 25 June 2024
Line 3:		Line 3:

	{{Added feature/item\|1.6.1\|1.6.0\|21938\|		{{Added feature/item\|1.6.1\|1.6.0\|21938\|
	Reads the entire contents of the file, optionally verifies the read contents by computing and comparing the checksum with the expected one, and returns the content as string. The file cursor position is not modified by calls to this function.		Reads the entire contents of the file, optionally verifies the read contents by computing and comparing the checksum with the expected one (file must be in meta.xml), and returns the content as string. The file cursor position is not modified by calls to this function.
	}}		}}

Line 27:		Line 27:
	*'''filePath:''' Path to a file you want to read		*'''filePath:''' Path to a file you want to read
	}}		}}
	*'''verifyContents:''' Set to true, to compare the computed and the expected checksum of the file content		*'''verifyContents:''' Set to true, to compare the computed and the expected checksum of the file content (file must be in meta.xml).

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

Tracer at 16:23, 24 June 2024

2024-06-24T16:23:59Z

← Older revision		Revision as of 16:23, 24 June 2024
Line 12:		Line 12:
	nil\|string fileGetContents ( file theFile [ , bool verifyContents = true ] )		nil\|string fileGetContents ( file theFile [ , bool verifyContents = true ] )
	</syntaxhighlight>		</syntaxhighlight>

			{{Added feature/item\|1.6.1\|1.6.0\|22560\|
			<syntaxhighlight lang="lua">
			nil\|string fileGetContents ( string filePath [ , bool verifyContents = true ] )
			</syntaxhighlight>
			}}

	{{OOP\|\|[[file]]:getContents}}		{{OOP\|\|[[file]]:getContents}}

	===Required Arguments===		===Required Arguments===
	*'''theFile:''' A handle to the file you wish to get the contents from. Use [[fileOpen]] to obtain this handle.		*'''theFile:''' A handle to the file you wish to get the contents from. Use [[fileOpen]] to obtain this handle.

			{{Added feature/item\|1.6.1\|1.6.0\|22560\|
			*'''filePath:''' Path to a file you want to read
			}}
	*'''verifyContents:''' Set to true, to compare the computed and the expected checksum of the file content		*'''verifyContents:''' Set to true, to compare the computed and the expected checksum of the file content

Line 22:		Line 33:

	==Example==		==Example==
			<section name="Shared" class="both" show="true">
	This example opens the code.lua file, checks its contents, and then runs it.		This example opens the code.lua file, checks its contents, and then runs it.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
Line 32:		Line 44:
	end		end
	</syntaxhighlight>		</syntaxhighlight>
			</section>

			<section name="Shared" class="both" show="true">
			This example reads content from a requested model and sends it back to the client.
			<syntaxhighlight lang="lua">
			addEvent('onRequestModel', true)
			addEventHandler('onRequestModel', resourceRoot, function(path)
			triggerClientEvent(client, 'onSendModel', client, fileGetContents(path))
			end)
			</syntaxhighlight>
			</section>

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

	[[pt-br:fileGetContents]]		[[pt-br:fileGetContents]]

Lettify: Portuguese version indexed

2023-12-20T18:30:32Z

Portuguese version indexed

← Older revision		Revision as of 18:30, 20 December 2023
Line 35:		Line 35:
	==See Also==		==See Also==
	{{File functions}}		{{File functions}}
			[[pt-br:fileGetContents]]

Nico834: Grammar and context correction

2023-10-24T18:33:58Z

Grammar and context correction

← Older revision		Revision as of 18:33, 24 October 2023
Line 22:		Line 22:

	==Example==		==Example==
	This example opens the file ~~test.txt and outputs~~ its contents ~~to the console~~.		This example opens the code.lua file, checks its contents, and then runs it.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	local handle = fileOpen("code.lua", true)		local handle = fileOpen("code.lua", true)

Botder at 20:54, 7 August 2023

2023-08-07T20:54:29Z

← Older revision		Revision as of 20:54, 7 August 2023
Line 2:		Line 2:
	{{Server client function}}		{{Server client function}}

	{{Added feature/item\|1.6.1\|1.6.0\|~~21933~~\|		{{Added feature/item\|1.6.1\|1.6.0\|21938\|
	Reads the entire contents of the file, optionally verifies the read contents by computing and comparing the checksum with the expected one, and returns the content as string. The file cursor position is not modified by calls to this function.		Reads the entire contents of the file, optionally verifies the read contents by computing and comparing the checksum with the expected one, and returns the content as string. The file cursor position is not modified by calls to this function.
	}}		}}

Botder at 20:06, 7 August 2023

2023-08-07T20:06:02Z

← Older revision		Revision as of 20:06, 7 August 2023
Line 3:		Line 3:

	{{Added feature/item\|1.6.1\|1.6.0\|21933\|		{{Added feature/item\|1.6.1\|1.6.0\|21933\|
	Reads the entire contents of the file ~~'''starting from the current file position'''~~, optionally verifies the read contents by computing and comparing the checksum with the expected one, and returns the content as string.		Reads the entire contents of the file, optionally verifies the read contents by computing and comparing the checksum with the expected one, and returns the content as string. The file cursor position is not modified by calls to this function.
	}}		}}