XmlLoadFile

2009-04-24T23:09:12Z

ChacalLoko: /* Returns */

__NOTOC__
{{Server client function}}
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.

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
xmlnode xmlLoadFile ( string filename, [ resource fromResource = getThisResource () ] )
</syntaxhighlight>

===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.

===Optional Arguments===
{{OptionalArg}}
*'''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 ''false'' otherwise.

==Example==
This example loads an XML file called ''test.xml''.
<syntaxhighlight lang="lua">
node = xmlLoadFile ( "test.xml" )
</syntaxhighlight>

==See Also==
{{XML_functions}}

Multi Theft Auto: Wiki - User contributions [en]

XmlLoadFile