Adobe ColdFusion 8

XmlElemNew

Description

Creates an XML document object element.

Returns

An XML document object element.

Category

XML functions

Function syntax

XmlElemNew(xmlObj[, namespace], childName)

See also

cfxml, IsXmlElem, XmlChildPos, XmlFormat, XmlNew, XmlParse; "Using XML and WDDX" in the ColdFusion Developer's Guide

History

ColdFusion MX 7: Added the namespace parameter.

ColdFusion MX: Added this function.

Parameters

Parameter

Description
xmlObj

Name of the XML document object in which you are creating the element
namespace

(Optional) URI of the namespace to which this element belongs
childName

Name of the element to create

Usage

The function's return variable specifies the location of the new element in the document object. It must specify a valid location in the document object identified by the xmlObj parameter. The following statements show this use:

MyDoc.MyRoot.XmlChildren[2] = XmlElemNew(MyDoc,"childNode");
ArrayAppend(MyDoc.MyRoot.XmlChildren, XmlElemNew(MyDoc,"childNode"));

If you do not specify a namespace URI and use a namespace prefix in the childName parameter, ColdFusion checks to see if a namespace URI has already been specified for the prefix, and if so, uses that namespace.

Example

The following example creates and displays a ColdFusion document object:

<cfscript>
    MyDoc = XmlNew();
    MyDoc.xmlRoot = XmlElemNew(MyDoc,"MyRoot");
    if (testVar IS TRUE)
        MyDoc.MyRoot.XmlText = "The value of testVar is True.";
    else 
        MyDoc.MyRoot.XmlText = "The value of testVar is False.";
    for (i = 1; i LTE 4; i = i + 1)
        {
        MyDoc.MyRoot.XmlChildren[i] = XmlElemNew(MyDoc,"childNode");
        MyDoc.MyRoot.XmlChildren[i].XmlText = "This is Child node " & i &".";
        }
</cfscript>
<cfdump var=#MyDoc#>