Difference between revisions of "STR REPLCE - Replace a sub-string of a string with another sub-string (Reports & Settings Report Generator function)"

From Catalyst
Jump to: navigation, search
(Updated from revision control)
(Updated from revision control)
Line 5: Line 5:
 
== Description ==
 
== Description ==
 
Replace a sub-string of a string with another sub-string.
 
Replace a sub-string of a string with another sub-string.
 +
 +
You may enclose any of the string or substring parameters between "[" and "]" to include leading or trailing spaces.
  
  

Revision as of 10:55, 13 September 2012

Syntax

$STR_REPLCE{string, search-sub-string, replace-sub-string, Count}

Description

Replace a sub-string of a string with another sub-string.

You may enclose any of the string or substring parameters between "[" and "]" to include leading or trailing spaces.


Parameters

string
A text parameter that can not be omitted.
The string that contains the sub-string.
search-sub-string
A text parameter that can not be omitted.
The sub-string, that will be searched for in the string.
replace-sub-string
A text parameter that can be omitted.
The substring, that will replace the Search sub-string in the main string. This defaults to nothing, the effect being that the Search sub-string will simply be removed.
Count
A text parameter that can be omitted (it defaults to "0").
The occurence of the Search sub-string to replace
0
Will replace all occurences of the Search sub-string.
1
Will replace the first occurence of the Search sub-string.
2
Will replace the second occurence of the Search sub-string.
-1
Will replace the last occurence of the Search sub-string.
-2
Will replace the penultimate occurence of the Search sub-string.

Returns

A text value. The string with the replacement(s).