Siebel eScript Language Reference > Methods Reference > String Methods >

Replace String Method

The Replace String method uses the regular expression that you define in the pattern argument to search a string. If it finds a match, then it replaces the string it finds with the string that you define in the replexp argument.

If you use T eScript code, and if this method replaces a string, then it sets the appropriate static properties for the regular expression object. These properties provide more information about the replacements. For more information, see Using the Get Regular Expression from String Method with the T eScript Engine.

Format

stringVar.replace(pattern, replexp)

Table 41 describes the arguments for the Replace String method.

Special Characters You Can Use in a Replacement Expression

Table 42 describes the special characters that you can use in a replacement expression.

Example

The following example includes the Replace String method:

var rtn;
var str = "one two three two one";
var pat = /(two)/g;

// rtn == "one zzz three zzz one"
rtn = str.replace(pat, "zzz");

// rtn == "one twozzz three twozzz one";
rtn = str.replace(pat, "$1zzz");

// rtn == "one 5 three 5 one"
rtn = str.replace(pat, five());

// rtn == "one twotwo three twotwo one";
rtn = str.replace(pat, "$&$&");

function five() {
   return 5;

}