User Guide
912 Chapter 3: ColdFusion Functions
XmlFormat
Description
Escapes special XML characters in a string so that the string can be used as text in XML.
Returns
A copy of the string parameter that is safe to use as text in XML.
Category
String functions, XML functions
Function syntax
XmlFormat(string)
See also
cfxml
, XmlNew, XmlParse, XmlValidate; Chapter 35, “Using XML and WDDX” in ColdFusion
MX Developer’s Guide
History
ColdFusion MX: Added this function.
Parameters
Usage
This function escapes characters as follows:
Example
The following example shows how XmlFormat escapes special XML characters. Use the View
Source command in the browser to see the results. ColdFusion interprets the "" in the second text
string as representing a single-quotation mark in text before it applies the
XmlFormat function.
<?xml version = "1.0"?>
<cfoutput>
Parameter Description
string A string or a variable that contains one
Text character Escaped representation
Greater than symbol (>) >
Less than symbol (<) <
Single-quotation mark (') '
Double-quotation mark (") "
Ampersand symbol (&) &
Carriage return (but not line feed) Removed from the text.
High ASCII characters in the range
128-255.
Replaced by unicode escape sequence; for example, É
(capital E with an Acute symbol) is replaced by É.