User Guide Cancel

EncodeForXML

 

Description

Encodes a string for XML.

Returns

Encoded XML string.

Category

Display and formatting functions.

Function syntax

encodeforXML(inputString [,canonicalize])

See also

Canonicalize,EncodeForHTMLAttribute,EncodeForJavaScript,EncodeForCSS,EncodeForURL

History

ColdFusion 10: Added this function.

Parameters

Parameter

Description

inputString

Required. The string to encode.

canonicalize

Optional. If set to true, canonicalization happens before encoding. If set to false, the given input string will just be encoded. The default value for canonicalize is false. When this parameter is not specified, canonicalization will not happen. By default, when canonicalization is performed, both mixed and multiple encodings will be allowed. To use any other combinations you should canonicalize using canonicalize method and then perform encoding.

Example

<cfscript>
x1=",.-_";
x2="<script>";
WriteOutput(EncodeForXML(x1) & " <br/> ");
WriteOutput(EncodeForXML(x2));
</cfscript>
<cfscript> x1=",.-_"; x2="<script>"; WriteOutput(EncodeForXML(x1) & " <br/> "); WriteOutput(EncodeForXML(x2)); </cfscript>
<cfscript>
    x1=",.-_";
    x2="<script>";
    WriteOutput(EncodeForXML(x1) & " <br/> ");
    WriteOutput(EncodeForXML(x2));
</cfscript>

Output

,.-_ 
<script>

Get help faster and easier

New user?