ColdFusion 9.0 Resources

Functions for XML object management

The following table lists the ColdFusion array and structure functions that you can use to manage XML document objects and their functions, and describes their common uses. In several cases you can use either an array function or a structure function for a purpose, such as for deleting all of an element’s attributes or children.

Function	Use
ArrayLen	Determines the number of child elements in an element, that is, the number of elements in an element’s `XmlChildren` array.
ArrayIsEmpty	Determines whether an element has any elements in its `XmlChildren` array.
StructCount	Determines the number of attributes in an element’s `XmlAttributes` structure.
StructIsEmpty	Determines whether an element has any attributes in its `XmlAttributes` structure. Returns `True` if the specified structure, including the XML document object or an element, exists and is empty.
StructKeyArray StructKeyList	Gets an array or list with the names of all of the attributes in an element’s `XmlAttributes` structure. Returns the names of the children of an XML element.
ArrayInsertAt	Adds a new element at a specific location in an element’s `XmlChildren` array.
ArrayAppend ArrayPrepend	Adds a new element at the end or beginning of an element’s `XmlChildren` array.
ArraySwap	Swaps the children in the `XmlChildren` array at the specified position.
ArraySet	Sets a range of entries in an `XmlChildren` array to equal the contents of a specified element structure. Each entry in the array range is a copy of the structure. Can be used to set a single element by specifying the same index as the beginning and end of the range.
ArrayDeleteAt	Deletes a specific element from an element’s `XmlChildren` array.
ArrayClear	Deletes all child elements from an element’s `XmlChildren` array.
StructDelete	Deletes a selected attribute from an element’s `XMLAttributes` structure. Deletes all children with a specific element name from an element’s `XmlChildren` array. Deletes all attributes of an element. Deletes all children of an element. Deletes a selected property value.
StructClear	Deletes all attributes from an element’s `XMLAttributes` structure.
Duplicate	Copies an XML document object, element, or node structure.
IsArray	Returns `True` for the `XmlChildren` array. Returns false if you specify an element name, such as mydoc.XmlRoot.name, even if multiple name elements exist in XmlRoot.
IsStruct	Returns False for XML document objects, elements, and nodes. Returns True for `XmlAttributes` structures.
StructGet	Returns the specified structure, including XML document objects, elements, nodes, and `XmlAttributes` structures.
StructAppend	Appends a document fragment XML document object to another XML document object.
StructInsert	Adds a new entry to an `XmlAttributes` structure.
StructUpdate	Sets or replaces the value of a document object property such as `XmlName`, or of a specified attribute in an `XmlAttributes` structure.

Note: Array and structure functions not in the preceding or table or the table in the next section, do not work with XML document objects, XML elements, or XML node structures.