XmlCopyFile: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 11: Line 11:
===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.
*'''newFilename:''' the file [[path]] for the new XML document.
*'''newFilename:''' the [[filepath]] for the new XML document.


===Optional Arguments===
===Optional Arguments===

Revision as of 21:21, 16 June 2009

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

Click to collapse [-]
Server
xmlnode xmlCopyFile ( xmlnode nodeToCopy, string newFilename, [ resource inResource = getThisResource() ] )

Required Arguments

  • nodeToCopy: the xmlnode that is to be copied to a new document.
  • newFilename: the filepath for the new XML document.

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

  • inResource: the resource whose directory will be used as the root for the filename specified. Note that if a different resource than default is being accessed, the caller resource needs access to general.ModifyOtherObjects in the ACL.
Click to collapse [-]
Client
xmlnode xmlCopyFile ( xmlnode nodeToCopy, string newFilename )

Required Arguments

  • nodeToCopy: the xmlnode that is to be copied to a new document.
  • newFilename: the filename for the new XML document.

Returns

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

Example

See Also