Difference between revisions of "XmlUnloadFile"
From Multi Theft Auto: Wiki
m (→Added 'See Also' related functions - added lua-tag to explaining code) |
m (fix oop syntax) |
||
| (10 intermediate revisions by 7 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | {{Server client function}} | |
| − | + | __NOTOC__ | |
| − | __NOTOC__ | + | Unloads an XML document from memory. |
| − | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
| − | bool xmlUnloadFile ( xmlnode | + | bool xmlUnloadFile ( xmlnode node ) |
</syntaxhighlight> | </syntaxhighlight> | ||
| − | + | {{OOP||[[xmlnode]]:unload}} | |
===Required Arguments=== | ===Required Arguments=== | ||
| − | *''' | + | *'''node:''' root of the XML document to unload |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
===Returns=== | ===Returns=== | ||
| − | Returns ''true'' if | + | Returns ''true'' if the document was unloaded successfully, ''false'' otherwise. |
==Example== | ==Example== | ||
| − | + | Modify a configuration file. | |
| + | |||
| + | config.xml: | ||
| + | <syntaxhighlight lang="xml"> | ||
| + | <config> | ||
| + | <markers color="255,100,0" /> | ||
| + | </config> | ||
| + | </syntaxhighlight> | ||
| + | |||
| + | Lua code: | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
| − | + | xml = xmlLoadFile("config.xml") | |
| − | + | markernode = xmlFindChild(xml, "markers", 0) | |
| − | + | xmlNodeSetAttribute(markernode, "color", "0,0,200") | |
| − | + | xmlSaveFile(xml) | |
| + | xmlUnloadFile(xml) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
| − | |||
{{XML_functions}} | {{XML_functions}} | ||
| + | [[ru:xmlUnloadFile]] | ||
Latest revision as of 20:16, 2 January 2015
Unloads an XML document from memory.
Syntax
bool xmlUnloadFile ( xmlnode node )
OOP Syntax Help! I don't understand this!
- Method: xmlnode:unload(...)
Required Arguments
- node: root of the XML document to unload
Returns
Returns true if the document was unloaded successfully, false otherwise.
Example
Modify a configuration file.
config.xml:
<config>
<markers color="255,100,0" />
</config>
Lua code:
xml = xmlLoadFile("config.xml")
markernode = xmlFindChild(xml, "markers", 0)
xmlNodeSetAttribute(markernode, "color", "0,0,200")
xmlSaveFile(xml)
xmlUnloadFile(xml)
