XmlCreateFile: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
Line 6: Line 6:
<section name="Server" class="server" show="true">
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
xmlnode xmlCreateFile ( string filename, string rootNodeName, resource root = getThisResource () )
xmlnode xmlCreateFile ( string filename, string rootNodeName, [ resource inResource = getThisResource() ] )
</syntaxhighlight>  
</syntaxhighlight>  


===Required Arguments===  
===Required Arguments===  
*'''filename:''' The name of the XML file you wish to create.
*'''filename:''' the name of the XML file you wish to create.
*'''rootNodeName:''' The name of the root node in the XML document.
*'''rootNodeName:''' the name of the root node in the XML document.
*'''root:''' Specifies which resource directory to use as root when specifying the filename. 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 root when specifying the filename. Note that if a different resource than default is being accessed, the caller resource needs access to general.ModifyOtherObjects in the [[ACL]].
</section>
</section>



Revision as of 01:01, 21 October 2007

This function creates a new XML document, which can later be saved to a file by using xmlSaveFile.

Syntax

Click to collapse [-]
Server
xmlnode xmlCreateFile ( string filename, string rootNodeName, [ resource inResource = getThisResource() ] )

Required Arguments

  • filename: the name of the XML file you wish to create.
  • rootNodeName: the name of the root node in the XML document.
  • inResource: the resource whose directory will be used as root when specifying the filename. 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 xmlCreateFile ( string filename, string rootNodeName )

Required Arguments

  • filename: The name of the XML file you wish to create.
  • rootNodeName: The name of the root node in the XML document.

Returns

Returns the root xmlnode object of the new XML file if successful, or false otherwise.

See Also