XmlLoadFile: Difference between revisions

Latest revision as of 22:04, 18 November 2018

This function provides an alternative way to load XML files to getResourceConfig. This function loads an XML file and returns the node by specifying a specific file path, while getResourceConfig allows for loading an XML file from a resource.

[[{{{image}}}\|link=\|]]	Note: To prevent memory leaks, ensure each call to xmlLoadFile has a matching call to xmlUnloadFile

Syntax

xmlnode xmlLoadFile ( string filePath [, bool readOnly = false ])

OOP Syntax Help! I don't understand this!

Note: This function is a static function underneath the XML class.

Method: XML.load(...)

Required Arguments

filePath: The filepath of the file in the following format: ":resourceName/path". 'resourceName' is the name of the resource the file is in, and 'path' is the path from the root directory of the resource to the file.

For example, if there is a file named 'settings.xml' in the resource 'ctf', it can be accessed from another resource this way: xmlLoadFile(":ctf/settings.xml").

If the file is in the current resource, only the file path is necessary, e.g. xmlLoadFile("settings.xml").

Optional Arguments

readOnly: By default, the XML file is opened with reading and writing access. You can specify true for this parameter if you only need reading access.

Returns

Returns the root xmlnode object of an xml file if successful, or false otherwise. Print error if something wrong with xml.

Example

This example loads an XML file called settings.xml that is in a resource called ctv.

node = xmlLoadFile ( ":ctv/settings.xml" )

@@ Line 3: / Line 3: @@
 This function provides an alternative way to load XML files to [[getResourceConfig]].
 This function loads an XML file and returns the node by specifying a specific file path, while [[getResourceConfig]] allows for loading an XML file from a resource.
+{{Note|To prevent memory leaks, ensure each call to [[xmlLoadFile]] has a matching call to [[xmlUnloadFile]]}}
 ==Syntax==
-<section name="Server" class="server" show="true">
 <syntaxhighlight lang="lua">
-xmlnode xmlLoadFile ( string filename, [ resource fromResource = getThisResource () ] )
+xmlnode xmlLoadFile ( string filePath [, bool readOnly = false ])
 </syntaxhighlight>
+{{OOP|This function is a static function underneath the XML class.|[[XML]].load||}}
 ===Required Arguments===
-*'''filename:''' the path to the file you wish to load.  This is a path relative to the current or specified resource root directory.
+*'''filePath:''' The [[filepath]] of the file in the following format: '''":resourceName/path"'''. 'resourceName' is the name of the resource the file is in, and 'path' is the path from the root directory of the resource to the file.
+:For example, if there is a file named 'settings.xml' in the resource 'ctf', it can be accessed from another resource this way: ''xmlLoadFile(":ctf/settings.xml")''.
+:If the file is in the current resource, only the file path is necessary, e.g. ''xmlLoadFile("settings.xml")''.
 ===Optional Arguments===
-{{OptionalArg}}
+*'''readOnly:''' By default, the XML file is opened with reading and writing access. You can specify ''true'' for this parameter if you only need reading access.
-*'''fromResource:''' the [[resource]] whose directory will be used as the root for the filename specified.
-</section>
-<section name="Client" class="client" show="true">
-<syntaxhighlight lang="lua">
-xmlnode xmlLoadFile ( string filename )
-</syntaxhighlight>
-===Required Arguments===
-*'''filename:''' The path to the file you wish to load.  This is a path relative to the clientside root folder of the resource found in your MTA San Andreas installation directory.'''.
-</section>
 ===Returns===
-Returns the root [[xmlnode]] object of an xml file if successful, or ''nil'' otherwise.
+Returns the root [[xmlnode]] object of an xml file if successful, or ''false'' otherwise.
+{{New items|3.0152|1.5|
+Print error if something wrong with xml.
+|7485}}
 ==Example==
-This example loads an XML file called ''test.xml''.
+This example loads an XML file called ''settings.xml'' that is in a resource called ''ctv''.
 <syntaxhighlight lang="lua">
-node = xmlLoadFile ( "test.xml" )
+node = xmlLoadFile ( ":ctv/settings.xml" )
 </syntaxhighlight>
 ==See Also==
 {{XML_functions}}
+[[ru:xmlLoadFile]]