MACROMEDIA COLDFUSION MX 61-CFML, Reference

Page: 639 / 806

PreserveSingleQuotes 639
PreserveSingleQuotes
Description
Prevents ColdFusion from automatically escaping single quotation mark characters that are
contained in a variable. ColdFusion does not evaluate the argument.
Returns
(None)
Category
Other functions
Function syntax
PreserveSingleQuotes ( variable )
History
ColdFusion MX: Changed behavior: ColdFusion automatically escapes simple-variable, array-
variable, and structure-variable references within a
cfquery
tag body or block. (Earlier releases
did not automatically escape array-variable references.)
Parameters
Usage
This function is useful in SQL statements to defer evaluation of a variable reference until
runtime. This prevents errors that result from the evaluation of a single-quote or apostrophe data
character (for example, "Joe’s Diner") as a delimiter.
Example A
: Consider this code:
<cfset mystring = "'Newton's Law', 'Fermat's Theorem'">
PreserveSingleQuotes(#mystring#) is
<cfoutput>
#PreserveSingleQuotes(mystring)#
</cfoutput>
The output is as follows:
PreserveSingleQuotes(#mystring#) is 'Newton's Law', 'Fermat's Theorem'
Example B
: Consider this code:
<cfset list0 = " '1','2''3' ">
<cfquery sql = "select * from foo where bar in (#list0#)">
ColdFusion escapes the single-quote characters in the list as follows:
""1"", ""2"", ""3""
The
cfquery
tag throws an error.
You code this function correctly as follows:
<cfquery sql = "select * from foo where bar in
(#preserveSingleQuotes(list0)#)">
Parameter Description
variable Variable that contains a string in which to preserve single quotation marks.