XmlCopyFile: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
Line 18: Line 18:


==Example==  
==Example==  
[[Category:Needs Example]]
<section name="Server" class="server" show="true">
In this example we will upload any (in the example config.xml) xml file and create a copy in a new folder with the name of copy-config.xml:
<syntaxhighlight lang="lua">
function()
local config = xmlLoadFile ( "config.xml" )
xmlCopyFile ( config, "copy/copy-config.xml" )
end
</syntaxhighlight>
</section>


==See Also==
==See Also==
{{XML_functions}}
{{XML_functions}}

Revision as of 09:50, 24 May 2010

This function copies all contents of a certain node in a XML document to a new document file, so the copied node becomes the new file's root node.

Syntax

xmlnode xmlCopyFile ( xmlnode nodeToCopy, string newFilePath )

Required Arguments

  • nodeToCopy: the xmlnode that is to be copied to a new document.
  • newFilePath: the path of the file that is to be created, 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, to create a file named 'newfile.xml' with myNode as the root node in the resource 'ctf', it can be done from another resource this way: xmlCopyFile(myNode, ":ctf/newfile.xml").
If the file is to be in the current resource, only the file path is necessary, e.g. xmlCopyFile(myNode, "newfile.xml").

Returns

Returns a xmlnode if the node was successfully copied, false if invalid arguments were passed.

Example

Click to collapse [-]
Server

In this example we will upload any (in the example config.xml) xml file and create a copy in a new folder with the name of copy-config.xml:

function()
	local config = xmlLoadFile ( "config.xml" )
	xmlCopyFile ( config, "copy/copy-config.xml" )
end

See Also