Description

Converts a string to a binary representation.

Returns

A binary object that represents the string.

Category

Conversion functionsString functions

Function syntax

CharsetDecode(string, encoding)

See also

BinaryDecodeBinaryEncodeCharsetEncode; Determining the page encoding of server output in Processing a request in ColdFusion in the Developing ColdFusion Applications

History

ColdFusion MX 7: Added this function.

Parameters

Parameter

Description

string

A string containing data to encode in binary format.

encoding

A string that specifies encoding of the input data. Must be a character encoding name recognized by the Java runtime. The following list includes commonly used values:

Usage

This function converts a string directly to a binary object. In releases of ColdFusion through ColdFusion MX 6.1, you had to use the ToBase64 function to convert the string to Base64 and then use the ToBinary function to convert strings to binary data.

Example

The following example uses the CharsetDecode function to convert a string to a binary object, and uses the CharsetEncode function to convert it back to the original value. You can change the character encoding that ColdFusion uses for the conversion.

If you select the Asian language encodings, characters that are not in the specified character set are successfully converted.

<h3>Character Encoding Conversion Example</h3> 
<!--- Do the conversions. --->
<cfscript> 
myString="Hello ColdFusion"
charEncoding='utf-8'
chardecode=CharsetDecode(myString, charEncoding); 
charencode=CharsetEncode(chardecode, charEncoding); 
</cfscript> 
 
<!--- Display the input values and results. --->
<cfoutput> 
<h3>Parameter Settings</h3> 
<p><b>The string:</b> 
#myString#</p> 
<p><b>The character encoding:</b> #charEncoding#</p> 
 
<h3>Results of the operations:</h3> 
<p><b>Dump of the string converted to a binary object by CharsetDecode: 
</b> 
<cfdump var="#chardecode#"></p> 
<p><b>The binary object converted back to a string by CharsetEncode: 
</b> 
#charencode#</p> 
</cfoutput>

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy