IsXMLRoot

Determines whether the function parameter is a root element node of an XML doc.

Method Signature

IsXMLRoot(value=[any])

Arguments

Argument	Type	Required	Description	Default
value	any	true	Value to test

Examples

"boxlangengines" is root element

<bx:xml variable="example">
	<boxlangengines>
		<engine>
			<name>Adobe ColdFusion</name>
		</engine>
		<engine>
			<name>Boxlang</name>
		</engine>
		<engine>
			<name>Railo</name>
		</engine>
		<engine>
			<name>Open BlueDragon</name>
		</engine>
	</boxlangengines>
</bx:xml>
<bx:script>
	writeOutput( isXMLRoot( example.BOXLANGENGINES ) );
</bx:script>

Result: YES

"engine" is child of "boxlangengines"

<bx:xml variable="example">
	<boxlangengines>
		<engine>
			<name>Adobe ColdFusion</name>
		</engine>
		<engine>
			<name>Boxlang</name>
		</engine>
		<engine>
			<name>Railo</name>
		</engine>
		<engine>
			<name>Open BlueDragon</name>
		</engine>
	</boxlangengines>
</bx:xml>
<bx:script>
	writeOutput( isXMLRoot( example.BOXLANGENGINES.ENGINE ) );
</bx:script>

Result: NO

Additional Examples

<bx:xml variable="xmlobject">
	<office>
		<employee>
			<emp_name>boxlang_dev</emp_name>
			<emp_no>121</emp_no>
		</employee>
	</office>
</bx:xml>
<bx:dump var="#IsXmlroot( xmlobject.OFFICE )#"/>

Related

• ArrayIsEmpty

• arrayIsEmpty

• Attempt

• IsArray

• IsBinary

• IsBoolean

• IsClosure

• IsCustomFunction

• IsDate

• IsDateObject

• IsDebugMode

• IsDefined

• IsEmpty

• IsFileObject

• IsIPv6

• IsJSON

• IsLeapYear

• IsLocalHost

• IsNull

• IsNumeric

• IsNumericDate

• IsObject

• IsQuery

• IsSimpleValue

• IsStruct

• IsValid

• IsXML

• IsXmlAttribute

• IsXMLDoc

• IsXMLElem

• IsXMLNode

• LSIsNumeric

• structIsEmpty