XmlCopyFile: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
mNo edit summary |
||
| Line 16: | Line 16: | ||
{{OptionalArg}} | {{OptionalArg}} | ||
*'''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]]. | *'''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]]. | ||
</section> | </section> | ||
| Line 29: | Line 26: | ||
*'''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 filename for the new XML document. | *'''newFilename:''' the filename for the new XML document. | ||
</section> | |||
===Returns=== | ===Returns=== | ||
Returns a [[xmlnode]] if the node was successfully copied, ''false'' if invalid arguments were passed. | Returns a [[xmlnode]] if the node was successfully copied, ''false'' if invalid arguments were passed. | ||
==Example== | ==Example== | ||
Revision as of 01:13, 21 October 2007
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 [-]
Serverxmlnode xmlCopyFile ( xmlnode nodeToCopy, string newFilename, [ resource inResource = getThisResource() ] )
Required Arguments
- nodeToCopy: the xmlnode that is to be copied to a new document.
- newFilename: the filename 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.
Click to expand [+]
ClientReturns
Returns a xmlnode if the node was successfully copied, false if invalid arguments were passed.
Example
See Also
- xmlCopyFile
- xmlCreateChild
- xmlCreateFile
- xmlDestroyNode
- xmlFindChild
- xmlLoadFile
- xmlLoadString
- xmlNodeGetAttribute
- xmlNodeGetAttributes
- xmlNodeGetChildren
- xmlNodeGetName
- xmlNodeGetParent
- xmlNodeGetValue
- xmlNodeSetAttribute
- xmlNodeSetName
- xmlNodeSetValue
- xmlSaveFile
- xmlUnloadFile