REReplace  
Description
Uses a regular expression (RE) to search a string for a string pattern and replace it with another. The search is case-sensitive.
 
Returns
If the scope attribute is set to one, returns a string with the first occurrence of the regular expression replaced by the value of substring.
If the scope attribute is set to all, returns a string with all occurrences of the regular expression replaced by the value of substring.
If the function finds no matches, it returns a copy of the string unchanged.
 
Category
String functions
 
Function syntax
REReplace(string, reg_expression, substring [, scope ])
 
See also
REFind, Replace, ReplaceList, REReplaceNoCase
 
History
ColdFusion MX: Added supports for the following special codes in a replacement substring, to control case conversion:
  • \u - uppercase the next character
  • \l - lowercase the next character
  • \U - uppercase until \E
  • \L - lowercase until \E
  • \E - end \U or \L
For more information on new features, see REFind.
 
Parameters
 
Parameter      Description
string A string or a variable that contains one. String within which to search.
reg_expression Regular expression to replace. The search is case-sensitive.
substring A string or a variable that contains one. Replaces reg_expression.
scope one: replace the first occurrence (default)
  all: replace all occurrences
 
Usage
For details on using regular expressions, see Chapter 7, "Using Regular Expressions in Functions," in Developing ColdFusion MX Applications.
 
Example
<p>The REReplace function returns <i>string</i> with a regular expression
replaced
with <i>substring</i> in the specified scope. Case-sensitive search.
<p>REReplace("CABARET","C|B","G","ALL"):
<cfoutput>#REReplace("CABARET","C|B","G","ALL")#</cfoutput>
<p>REReplace("CABARET","[A-Z]","G","ALL"):
<cfoutput>#REReplace("CABARET","[A-Z]","G","ALL")#</cfoutput>
<p>REReplace("I love jellies","jell(y|ies)","cookies"):
<cfoutput>#REReplace("I love jellies","jell(y|ies)","cookies")#
 </cfoutput>
<p>REReplace("I love jelly","jell(y|ies)","cookies"):
<cfoutput>#REReplace("I love jelly","jell(y|ies)","cookies")#</cfoutput>
string  
A string or a variable that contains one. String within which to search.
reg_expression  
Regular expression to replace. The search is case-sensitive.
substring  
A string or a variable that contains one. Replaces reg_expression.
scope  
  • one: replace the first occurrence (default)
  • all: replace all occurrences