User Guide

URLEncodedFormat 731
URLEncodedFormat
Description
Generates a URL-encoded string. For example, it replaces spaces with %20, and non-
alphanumeric characters with equivalent hexadecimal escape sequences. Passes arbitrary strings
within a URL (ColdFusion automatically decodes URL parameters that are passed to a page).
Returns
A copy of a string, URL-encoded.
Category
Conversion functions, Other functions, String functions
Function syntax
URLEncodedFormat(string [, charset ])
See also
URLDecode
History
ColdFusion MX 6.1: Changed the default encoding to be the response character encoding.
ColdFusion MX: Added the
charset parameter.
Parameters
Usage
URL encoding formats some characters with a percent sign and the two-character hexadecimal
representation of the character. For example, a character whose code is 129 is encoded as
%81. A
space is encoded with a plus sign.
Query strings in HTTP are always URL-encoded.
Example
<h3>URLEncodedFormat Example</h3>
Parameter Description
string A string or a variable that contains one
charset The character encoding in which the string is encoded. Optional.
The following list includes commonly used values:
• utf-8
• iso-8859-1
• windows-1252
• us-ascii
• shift_jis
• iso-2022-jp
• euc-jp
• euc-kr
• big5
• euc-cn
• utf-16
For more information on character encoding, see:
www.w3.org/International/O-charset.html.
Default: the character encoding of the response. See cfcontent on page 87.