FileOpen - Revision history

Srslyyyy: Remove XML note

2024-12-04T16:52:46Z

Remove XML note

← Older revision		Revision as of 16:52, 4 December 2024
Line 3:		Line 3:
	Opens an existing file for reading and writing.		Opens an existing file for reading and writing.
	{{Note\|To prevent memory leaks, ensure each successful call to [[fileOpen]] has a matching call to [[fileClose]].}}		{{Note\|To prevent memory leaks, ensure each successful call to [[fileOpen]] has a matching call to [[fileClose]].}}
	~~{{Tip\|The file functions should not be used to implement configuration files. It is encouraged to use the XML functions for this instead.}}~~
	{{MessageBox\|bordercolorhex=FFB2B2\|bgcolorhex=FFE5E5\|image=File:Dialog-warning.png\|title=Warning:\|message=As of 1.5.4 [https://buildinfo.mtasa.com/?Author=&Branch=&Revision=10413 r10413], this function will fail when trying to access a script file of another resource, even with ''general.ModifyOtherObjects'' rights granted, which uses a ''mysql'' connection through [[dbConnect]] when [[Server_mtaserver.conf#database_credentials_protection\|''database_credentials_protection'']] is enabled in the server configuration. Additionally, meta.xml will be un-writable and will always open in read-only mode.}} <!-- The {Warning} template didn't want to work with an external link to buildinfo, so I had to use the {MessageBox} template -->		{{MessageBox\|bordercolorhex=FFB2B2\|bgcolorhex=FFE5E5\|image=File:Dialog-warning.png\|title=Warning:\|message=As of 1.5.4 [https://buildinfo.mtasa.com/?Author=&Branch=&Revision=10413 r10413], this function will fail when trying to access a script file of another resource, even with ''general.ModifyOtherObjects'' rights granted, which uses a ''mysql'' connection through [[dbConnect]] when [[Server_mtaserver.conf#database_credentials_protection\|''database_credentials_protection'']] is enabled in the server configuration. Additionally, meta.xml will be un-writable and will always open in read-only mode.}} <!-- The {Warning} template didn't want to work with an external link to buildinfo, so I had to use the {MessageBox} template -->

Lettify: Portuguese version indexed

2023-12-20T19:25:36Z

Portuguese version indexed

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

Necktrox at 13:32, 1 March 2018

2018-03-01T13:32:21Z

← Older revision		Revision as of 13:32, 1 March 2018
Line 10:		Line 10:
	file fileOpen ( string filePath [, bool readOnly = false ])		file fileOpen ( string filePath [, bool readOnly = false ])
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|\|[[File]]}}		{{OOP\|The function will only attempt to open the file, it won't create it.\|[[File]]}}

			{{New feature/item\|9.0156\|1.5.6\|11865\|
			{{OOP\|This is a static function underneath the File class. Using '''File(...)''' to open a file will attempt to create the file, if it doesn't exist\|[[File]].open}}
			}}

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

Pirulax: /* Example */

2017-08-12T18:32:26Z

Example

← Older revision		Revision as of 18:32, 12 August 2017
Line 45:		Line 45:
	fileSetPos( hFile, fileGetSize( hFile ) ) -- move position to the end of the file		fileSetPos( hFile, fileGetSize( hFile ) ) -- move position to the end of the file
	fileWrite(hFile, "hello" ) -- append data		fileWrite(hFile, "hello" ) -- append data
			fileFlush(hFile) -- Flush the appended data into the file.
	fileClose(hFile) -- close the file once we're done with it		fileClose(hFile) -- close the file once we're done with it
	else		else
Line 50:		Line 51:
	end		end
	</syntaxhighlight>		</syntaxhighlight>

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

MrTasty: Added warning about function's limitations as of 1.5.4.

2017-08-04T14:29:01Z

Added warning about function's limitations as of 1.5.4.

← Older revision		Revision as of 14:29, 4 August 2017
Line 2:		Line 2:
	{{Server client function}}		{{Server client function}}
	Opens an existing file for reading and writing.		Opens an existing file for reading and writing.
	{{Note\|To prevent memory leaks, ensure each successful call to [[fileOpen]] has a matching call to [[fileClose]]}}		{{Note\|To prevent memory leaks, ensure each successful call to [[fileOpen]] has a matching call to [[fileClose]].}}
	{{Tip\|The file functions should not be used to implement configuration files. It is encouraged to use the XML functions for this instead.}}		{{Tip\|The file functions should not be used to implement configuration files. It is encouraged to use the XML functions for this instead.}}
			{{MessageBox\|bordercolorhex=FFB2B2\|bgcolorhex=FFE5E5\|image=File:Dialog-warning.png\|title=Warning:\|message=As of 1.5.4 [https://buildinfo.mtasa.com/?Author=&Branch=&Revision=10413 r10413], this function will fail when trying to access a script file of another resource, even with ''general.ModifyOtherObjects'' rights granted, which uses a ''mysql'' connection through [[dbConnect]] when [[Server_mtaserver.conf#database_credentials_protection\|''database_credentials_protection'']] is enabled in the server configuration. Additionally, meta.xml will be un-writable and will always open in read-only mode.}} <!-- The {Warning} template didn't want to work with an external link to buildinfo, so I had to use the {MessageBox} template -->

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

Ccw at 00:08, 14 February 2015

2015-02-14T00:08:08Z

← Older revision		Revision as of 00:08, 14 February 2015
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server client function}}		{{Server client function}}

	Opens an existing file for reading and writing.		Opens an existing file for reading and writing.
			{{Note\|To prevent memory leaks, ensure each successful call to [[fileOpen]] has a matching call to [[fileClose]]}}
	~~'''Note:'''~~ The file functions should not be used to implement configuration files. It is encouraged to use the XML functions for this instead.		{{Tip\|The file functions should not be used to implement configuration files. It is encouraged to use the XML functions for this instead.}}

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
Line 39:		Line 37:
	</syntaxhighlight>		</syntaxhighlight>

	~~Notice that you can't simply do ''buffer~~ = ~~fileRead~~("test.txt"~~, 500~~)~~''. Instead, file functions operate on a '''file handle''', which is a special object representing an~~ open file~~. fileOpen gives us such a handle.~~		This example show how to append data to an existing file:
			<syntaxhighlight lang="lua">
	~~It is also important~~ to ~~remember to close a~~ file ~~after you've finished all your operations on it~~, ~~especially if you've been writing to~~ the file~~. If you don~~'~~t close a file and your resource crashes, all changes~~ to ~~the file may be lost~~.		local hFile = fileOpen("test.txt") -- attempt to open the file (read and write mode)
			if hFile then -- check if it was successfully opened
			fileSetPos( hFile, fileGetSize( hFile ) ) -- move position to the end of the file
			fileWrite(hFile, "hello" ) -- append data
			fileClose(hFile) -- close the file once we're done with it
			else
			outputConsole("Unable to open test.txt")
			end
			</syntaxhighlight>
	==See Also==		==See Also==
	{{File functions}}		{{File functions}}

Strix at 20:48, 2 January 2015

2015-01-02T20:48:36Z

@@ Line 7: / Line 7: @@
 ==Syntax==
 <syntaxhighlight lang="lua">
 file fileOpen ( string filePath [, bool readOnly = false ])
@@ Line 20: / Line 19: @@
 ===Optional Arguments===
 *'''readOnly:''' By default, the file is opened with reading and writing access. You can specify ''true'' for this parameter if you only need reading access.
 ===Returns===

Strix: add oop syntax

2015-01-02T20:28:39Z

add oop syntax

← Older revision		Revision as of 20:28, 2 January 2015
Line 11:		Line 11:
	file fileOpen ( string filePath [, bool readOnly = false ])		file fileOpen ( string filePath [, bool readOnly = false ])
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|\|[[File]]}}

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

Ccw at 12:00, 13 September 2011

2011-09-13T12:00:49Z

← Older revision		Revision as of 12:00, 13 September 2011
Line 21:		Line 21:

	</section>		</section>


	{{New feature\|3.0110\|1.1\|		{{New feature\|3.0110\|1.1\|
	<section name="Client" class="client" show="true">		<section name="Client" class="client" show="true">

Ccw at 12:00, 13 September 2011

2011-09-13T12:00:38Z

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

	Opens an existing file for reading and writing.		Opens an existing file for reading and writing.