XmlLoadFile

From Multi Theft Auto: Wiki
Jump to: navigation, search

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 )

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").

Returns

Returns the root xmlnode object of an xml file if successful, or false otherwise.

FROM VERSION 1.6 r7485 ONWARDS

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" )

See Also