XmlCopyFile - Revision history

Ccw at 23:15, 13 February 2015

2015-02-13T23:15:34Z

← Older revision		Revision as of 23:15, 13 February 2015
Line 3:		Line 3:
	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.		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		The new file will not be saved to file system until [[xmlSaveFile]]() is called
			{{Note\|To prevent memory leaks, ensure each call to [[xmlCopyFile]] has a matching call to [[xmlUnloadFile]]}}
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

2014-09-30T16:36:07Z

2014-07-12T20:40:25Z

Syntax: OOP syntax added

← Older revision		Revision as of 20:40, 12 July 2014
Line 8:		Line 8:
	xmlnode xmlCopyFile ( xmlnode nodeToCopy, string newFilePath )		xmlnode xmlCopyFile ( xmlnode nodeToCopy, string newFilePath )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|\|[[xmlnode]]:copy\|\|}}
	===Required Arguments===		===Required Arguments===
	*'''nodeToCopy:''' the [[xmlnode]] that is to be copied to a new document.		*'''nodeToCopy:''' the [[xmlnode]] that is to be copied to a new document.

2014-03-02T22:27:52Z

Example

← Older revision		Revision as of 22:27, 2 March 2014
Line 24:		Line 24:
	-- create a copy of xml structure in memory		-- create a copy of xml structure in memory
	local newFile = xmlCopyFile(config, "copy/copy-config.xml")		local newFile = xmlCopyFile(config, "copy/copy-config.xml")
	-- write this new copy to a filesystem		if newFile then
	xmlSaveFile(newFile)		-- write this new copy to a filesystem
			xmlSaveFile(newFile)
			end
	-- unload config xml node from memory if it will not be used anytime soon		-- unload config xml node from memory if it will not be used anytime soon
	xmlUnloadFile(config)		xmlUnloadFile(config)

2014-03-02T22:27:11Z

← Older revision		Revision as of 22:27, 2 March 2014
Line 2:		Line 2:
	{{Server client function}}		{{Server client function}}
	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.		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		The new file will not be saved to file system until [[xmlSaveFile]]() is called

	==Syntax==		==Syntax==

2014-03-02T22:26:36Z

← Older revision		Revision as of 22:26, 2 March 2014
Line 2:		Line 2:
	{{Server client function}}		{{Server client function}}
	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.		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		The new file will not be saved to file system until [[xmlSaveFile]] is called

	==Syntax==		==Syntax==

2014-03-02T22:26:15Z

← Older revision		Revision as of 22:26, 2 March 2014
Line 2:		Line 2:
	{{Server client function}}		{{Server client function}}
	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.		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

	==Syntax==		==Syntax==

2014-03-02T22:25:19Z

Example

← Older revision		Revision as of 22:25, 2 March 2014
Line 21:		Line 21:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	local config = xmlLoadFile("config.xml")		local config = xmlLoadFile("config.xml")
	xmlCopyFile(config, "copy/copy-config.xml")		-- create a copy of xml structure in memory
			local newFile = xmlCopyFile(config, "copy/copy-config.xml")
			-- write this new copy to a filesystem
			xmlSaveFile(newFile)
			-- unload config xml node from memory if it will not be used anytime soon
			xmlUnloadFile(config)
	</syntaxhighlight>		</syntaxhighlight>

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

2013-08-26T08:22:01Z

← Older revision		Revision as of 08:22, 26 August 2013
Line 15:		Line 15:

	===Returns===		===Returns===
	Returns a [[xmlnode]] if the node was successfully copied, ''false'' if invalid arguments were passed.		Returns the [[xmlnode]] of the copy if the node was successfully copied, ''false'' if invalid arguments were passed.

	==Example==		==Example==

2012-12-11T19:57:26Z

Syntax

@@ Line 4: / Line 4: @@
 ==Syntax==
 <syntaxhighlight lang="lua">
 xmlnode xmlCopyFile ( xmlnode nodeToCopy, string newFilePath )
@@ Line 14: / Line 13: @@
 :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===