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. The new file will not be saved to file system until xmlSaveFile is called.

Caution

To prevent memory leaks, ensure each call to xmlCopyFile has a matching call to xmlUnloadFile.

OOP Syntax Help! I don't understand this!

• Method: xmlnode:copy(...)

Syntax

xmlnode|false 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. If the file is to be in the current resource, only the file path is necessary, e.g. "newfile.xml". 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

• xmlnode|false: xmlnode

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

Code Examples

Example 1 Example 2 (OOP)

shared

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

local config = xmlLoadFile("config.xml")
-- If the file doesn't exist, we don't proceed.
if (not config) then
    return
end

-- Create a copy of xml structure in memory
local newFile = xmlCopyFile(config, "copy/copy-config.xml")
if (newFile) then
  -- Write this new copy to a filesystem
  xmlSaveFile(newFile)
end
-- Unload config xml node from memory if it will not be used anytime soon
xmlUnloadFile(config)

shared

OOP Required

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

local config = XML.load("config.xml")
-- If the file doesn't exist, we don't proceed.
if (not config) then
    return
end

-- Create a copy of xml structure in memory
local newFile = config:copy("copy/copy-config.xml")
if (newFile) then
  -- Write this new copy to a filesystem
  newFile:saveFile()
end
-- Unload config xml node from memory if it will not be used anytime soon
config:unload()

See Also

XML Functions

• xmlCopyFile
• xmlCreateChild
• xmlCreateFile
• xmlDestroyNode
• xmlFindChild
• xmlLoadFile
• xmlLoadString
• xmlNodeGetAttribute
• xmlNodeGetAttributes
• xmlNodeGetChildren
• xmlNodeGetName
• xmlNodeGetParent
• xmlNodeGetValue
• xmlNodeSetAttribute
• xmlNodeSetName
• xmlNodeSetValue
• xmlSaveFile
• xmlUnloadFile

XML Elements

• xmlnode

Reference

• Scripting Functions