XmlCreateFile: Difference between revisions
Jump to navigation
Jump to search
| Line 19: | Line 19: | ||
==Example== | ==Example== | ||
<section name="Client" class="client" show="true"> | |||
This example allows a player to use the command 'createfile' to create an .xml file. | |||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
-- | -- Creates a file named "new.xml" with root node "newroot" and childnode "newchild". | ||
function createFileHandler() | |||
local RootNode = xmlCreateFile("new.xml"," newroot") | |||
local NewNode = xmlCreateChild(RootNode, "newchild") | |||
xmlSaveFile(RootNode) | |||
end | |||
addCommandHandler("createfile", createFileHandler) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
</section> | |||
==See Also== | ==See Also== | ||
{{XML_functions}} | {{XML_functions}} | ||
[[Category:Needs Example]] | [[Category:Needs Example]] | ||
Revision as of 13:30, 10 November 2010
This function creates a new XML document, which can later be saved to a file by using xmlSaveFile. This function will overwrite the file specified if it already exists.
Syntax
xmlnode xmlCreateFile ( string filePath, string rootNodeName )
Required Arguments
- filePath: The filepath of the file in the following format: ":resourceName/path". 'resourceName' is the name of the resource the file will be in, and 'path' is the path from the root directory of the resource to the file.
- For example, if you want to create a file named 'new.xml' in the resource 'ctf', it can be created from another resource this way: xmlCreateFile(":ctf/new.xml", "newroot").
- If the file is in the current resource, only the file path is necessary, e.g. xmlCreateFile("new.xml", "newroot").
- Note that if a different resource than default is being accessed, the caller resource needs access to general.ModifyOtherObjects in the ACL.
- rootNodeName: the name of the root node in the XML document.
Returns
Returns the root xmlnode object of the new XML file if successful, or false otherwise.
Example
Click to collapse [-]
ClientThis example allows a player to use the command 'createfile' to create an .xml file.
-- Creates a file named "new.xml" with root node "newroot" and childnode "newchild".
function createFileHandler()
local RootNode = xmlCreateFile("new.xml"," newroot")
local NewNode = xmlCreateChild(RootNode, "newchild")
xmlSaveFile(RootNode)
end
addCommandHandler("createfile", createFileHandler)