NGWS SDK Documentation  

This is preliminary documentation and subject to change.
To comment on this topic, please send us email at ngwssdk@microsoft.com. Thanks!

Replace Function

Returns a string in which a specified substring has been replaced with another substring a specified number of times.

Replace(expression, find, replace[, start[, count[, compare]]])

Arguments

expression
Required. String expression containing substring to replace.
find
Required. Substring being searched for.
replace
Required. Replacement substring.
start
Optional. Position within expression where substring search is to begin. If omitted, 1 is assumed.
count
Optional. Number of substring substitutions to perform. If omitted, the default value is –1, which means make all possible substitutions.
compare
Optional. Numeric value indicating the kind of comparison to use when evaluating substrings. See Settings section for values.

Settings

The compare argument can have the following values:

Constant Value Description
BinaryCompare 0 Performs a binary comparison.
TextCompare 1 Performs a textual comparison.

Return Values

Replace returns the following values:

If Replace returns
expression is zero-length Zero-length string ("")
find is zero-length Copy of expression.
replace is zero-length Copy of expression with all occurences of find removed.
start > Len(expression) Zero-length string.
count is 0 Copy of expression.

Remarks

The return value of the Replace function is a string that begins at the position specified by start and concludes at the end of the expression string, with the substitutions made as specified by the find and replace values. It is not a copy of the original string from start to finish.

See Also

Filter Function