XmlCreateFile: Difference between revisions
Jump to navigation
Jump to search
Ronwolf1705 (talk | contribs) No edit summary |
Ronwolf1705 (talk | contribs) No edit summary |
||
Line 3: | Line 3: | ||
This function creates a new XML document, which can later be saved to a file by using [[xmlSaveFile]]. This function will overwrite the file specified if it already exists. | This function creates a new XML document, which can later be saved to a file by using [[xmlSaveFile]]. This function will overwrite the file specified if it already exists. | ||
{{Needs_Checking|it's server-side only}} | {{Needs_Checking|it's server-side only// ronwolf1705}} | ||
==Syntax== | ==Syntax== |
Revision as of 12:49, 28 April 2012
This function creates a new XML document, which can later be saved to a file by using xmlSaveFile. This function will overwrite the file specified if it already exists.
![]() |
This article needs checking. |
Reason(s): it's server-side only// ronwolf1705 |
Syntax
Click to collapse [-]
Serverxmlnode xmlCreateFile ( string filePath, string rootNodeName )
Required Arguments
- filePath: The filepath of the file in the following format: ":resourceName/path". 'resourceName' is the name of the resource the file will be in, and 'path' is the path from the root directory of the resource to the file.
- For example, if you want to create a file named 'new.xml' in the resource 'ctf', it can be created from another resource this way: xmlCreateFile(":ctf/new.xml", "newroot").
- If the file is in the current resource, only the file path is necessary, e.g. xmlCreateFile("new.xml", "newroot").
- Note that if a different resource than default is being accessed, the caller resource needs access to general.ModifyOtherObjects in the ACL.
- rootNodeName: the name of the root node in the XML document.
Click to collapse [-]
Clientxmlnode xmlCreateFile ( string filePath, string rootNodeName )
Required Arguments
- filePath: The filepath of the file in the following format: ":resourceName/path". 'resourceName' is the name of the resource the file will be in, and 'path' is the path from the root directory of the resource to the file.
- For example, if you want to create a file named 'new.xml' in the resource 'ctf', it can be created from another resource this way: xmlCreateFile(":ctf/new.xml", "newroot").
- If the file is in the current resource, only the file path is necessary, e.g. xmlCreateFile("new.xml", "newroot").
- Note that if a different resource than default is being accessed, the caller resource needs access to general.ModifyOtherObjects in the ACL.
- 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.
Example
Click to collapse [-]
ClientThis example allows a player to use the command 'createfile' to create an .xml file.
-- Creates a file named "new.xml" with root node "newroot" and childnode "newchild". function createFileHandler() local RootNode = xmlCreateFile("new.xml"," newroot") local NewNode = xmlCreateChild(RootNode, "newchild") xmlSaveFile(RootNode) end addCommandHandler("createfile", createFileHandler)
See Also
- xmlCopyFile
- xmlCreateChild
- xmlCreateFile
- xmlDestroyNode
- xmlFindChild
- xmlLoadFile
- xmlLoadString
- xmlNodeGetAttribute
- xmlNodeGetAttributes
- xmlNodeGetChildren
- xmlNodeGetName
- xmlNodeGetParent
- xmlNodeGetValue
- xmlNodeSetAttribute
- xmlNodeSetName
- xmlNodeSetValue
- xmlSaveFile
- xmlUnloadFile