Determines whether the function parameter is the root element of an XML document object.

Decision Functions XML Functions

isXML isXmlAttribute isXmlDoc isXmlElem isXmlNode xmlGetNodeType xmlValidate

ColdFusion MX: Added this function.

IsXmlRoot(value)

True, if the function argument is the root object of an XML document object; False, otherwise.

The following example tests whether an XML document object, its root element, and a child element are XML root elements:

<!--- Create an XML document object ---> 
<cfxml variable="xmlobject"> 
<?xml version="1.0" encoding="UTF-8"?> 
<order id="4323251"> 
    <customer firstname="Philip" lastname="Cramer" accountNum="21"/> 
    <items> 
        <item id="43"> 
            <quantity>1</quantity> 
            <unitprice>15.95</unitprice> 
        </item> 
    </items> 
</order> 
</cfxml> 
 
<!--- Test objects to see if they are XML root elements ---> 
<cfoutput> 
<h3>Are the following the XML Root?</h3> 
xmlobject: #IsXmlRoot(xmlobject)#<br> 
xmlobject.order: #IsXmlRoot(xmlobject.order)#<br> 
<!--- The order element id attribute ---> 
xmlobject.order.XmlAttributes.id:  
    #IsXmlRoot(xmlobject.order.XmlAttributes.id)#<br> 
</cfoutput>