XmlLoadFile - Revision history

StrixG at 22:04, 18 November 2018

2018-11-18T22:04:06Z

← Older revision		Revision as of 22:04, 18 November 2018
Line 19:		Line 19:
	===Returns===		===Returns===
	Returns the root [[xmlnode]] object of an xml file if successful, or ''false'' otherwise.		Returns the root [[xmlnode]] object of an xml file if successful, or ''false'' otherwise.
	{{New items\|3.02\|1.5\|		{{New items\|3.0152\|1.5\|
	Print error if something wrong with xml.		Print error if something wrong with xml.
	\|7485}}		\|7485}}

2018-11-18T22:02:30Z

← Older revision		Revision as of 22:02, 18 November 2018
Line 19:		Line 19:
	===Returns===		===Returns===
	Returns the root [[xmlnode]] object of an xml file if successful, or ''false'' otherwise.		Returns the root [[xmlnode]] object of an xml file if successful, or ''false'' otherwise.
	{{New items\|3.02\|1.6\|		{{New items\|3.02\|1.5\|
	Print error if something wrong with xml.		Print error if something wrong with xml.
	\|7485}}		\|7485}}

2018-08-02T23:35:22Z

Added undocumented parameter

← Older revision		Revision as of 23:35, 2 August 2018
Line 6:		Line 6:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	xmlnode xmlLoadFile ( string filePath )		xmlnode xmlLoadFile ( string filePath [, bool readOnly = false ])
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|This function is a static function underneath the XML class.\|[[XML]].load\|\|}}		{{OOP\|This function is a static function underneath the XML class.\|[[XML]].load\|\|}}
Line 13:		Line 13:
	:For example, if there is a file named 'settings.xml' in the resource 'ctf', it can be accessed from another resource this way: ''xmlLoadFile(":ctf/settings.xml")''.		:For example, if there is a file named 'settings.xml' in the resource 'ctf', it can be accessed from another resource this way: ''xmlLoadFile(":ctf/settings.xml")''.
	:If the file is in the current resource, only the file path is necessary, e.g. ''xmlLoadFile("settings.xml")''.		:If the file is in the current resource, only the file path is necessary, e.g. ''xmlLoadFile("settings.xml")''.

			===Optional Arguments===
			*'''readOnly:''' By default, the XML file is opened with reading and writing access. You can specify ''true'' for this parameter if you only need reading access.

	===Returns===		===Returns===

2017-11-29T15:18:16Z

Returns

← Older revision		Revision as of 15:18, 29 November 2017
Line 16:		Line 16:
	===Returns===		===Returns===
	Returns the root [[xmlnode]] object of an xml file if successful, or ''false'' otherwise.		Returns the root [[xmlnode]] object of an xml file if successful, or ''false'' otherwise.
			{{New items\|3.02\|1.6\|
			Print error if something wrong with xml.
			\|7485}}

	==Example==		==Example==

2015-02-13T23:16:01Z

← Older revision		Revision as of 23:16, 13 February 2015
Line 3:		Line 3:
	This function provides an alternative way to load XML files to [[getResourceConfig]].		This function provides an alternative way to load XML files to [[getResourceConfig]].
	This function loads an XML file and returns the node by specifying a specific file path, while [[getResourceConfig]] allows for loading an XML file from a resource.		This function loads an XML file and returns the node by specifying a specific file path, while [[getResourceConfig]] allows for loading an XML file from a resource.
	{{Note\|To prevent ~~memork~~ leaks, ensure each call to [[xmlLoadFile]] has a matching call to [[xmlUnloadFile]]}}		{{Note\|To prevent memory leaks, ensure each call to [[xmlLoadFile]] has a matching call to [[xmlUnloadFile]]}}
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

2015-02-13T23:13:49Z

← Older revision		Revision as of 23:13, 13 February 2015
Line 3:		Line 3:
	This function provides an alternative way to load XML files to [[getResourceConfig]].		This function provides an alternative way to load XML files to [[getResourceConfig]].
	This function loads an XML file and returns the node by specifying a specific file path, while [[getResourceConfig]] allows for loading an XML file from a resource.		This function loads an XML file and returns the node by specifying a specific file path, while [[getResourceConfig]] allows for loading an XML file from a resource.
			{{Note\|To prevent memork leaks, ensure each call to [[xmlLoadFile]] has a matching call to [[xmlUnloadFile]]}}
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

2015-01-02T20:15:17Z

← Older revision		Revision as of 20:15, 2 January 2015
Line 8:		Line 8:
	xmlnode xmlLoadFile ( string filePath )		xmlnode xmlLoadFile ( string filePath )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|This function is a static function underneath the XML class\|[[XML]].load\|\|}}		{{OOP\|This function is a static function underneath the XML class.\|[[XML]].load\|\|}}
	===Required Arguments===		===Required Arguments===
	*'''filePath:''' The [[filepath]] of the file in the following format: '''":resourceName/path"'''. 'resourceName' is the name of the resource the file is in, and 'path' is the path from the root directory of the resource to the file.		*'''filePath:''' The [[filepath]] of the file in the following format: '''":resourceName/path"'''. 'resourceName' is the name of the resource the file is in, and 'path' is the path from the root directory of the resource to the file.

2015-01-02T20:14:49Z

← Older revision		Revision as of 20:14, 2 January 2015
Line 8:		Line 8:
	xmlnode xmlLoadFile ( string filePath )		xmlnode xmlLoadFile ( string filePath )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|\|XML.load\|\|}}		{{OOP\|This function is a static function underneath the XML class\|[[XML]].load\|\|}}
	===Required Arguments===		===Required Arguments===
	*'''filePath:''' The [[filepath]] of the file in the following format: '''":resourceName/path"'''. 'resourceName' is the name of the resource the file is in, and 'path' is the path from the root directory of the resource to the file.		*'''filePath:''' The [[filepath]] of the file in the following format: '''":resourceName/path"'''. 'resourceName' is the name of the resource the file is in, and 'path' is the path from the root directory of the resource to the file.

2014-10-01T22:36:33Z

2014-07-12T20:38:13Z

Syntax: OOP syntax added

← Older revision		Revision as of 20:38, 12 July 2014
Line 8:		Line 8:
	xmlnode xmlLoadFile ( string filePath )		xmlnode xmlLoadFile ( string filePath )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|\|XML.load\|\|}}
	===Required Arguments===		===Required Arguments===
	*'''filePath:''' The [[filepath]] of the file in the following format: '''":resourceName/path"'''. 'resourceName' is the name of the resource the file is in, and 'path' is the path from the root directory of the resource to the file.		*'''filePath:''' The [[filepath]] of the file in the following format: '''":resourceName/path"'''. 'resourceName' is the name of the resource the file is in, and 'path' is the path from the root directory of the resource to the file.