Function FindReplaceStrings(SearchString, Key, Replacement, CaseSensitive, WordOnly)

FindReplaceStrings

The function FindReplaceStrings constructs a string by searching for every occurrence of a substring (a key) within a search string and replaces it with another string. It returns the constructed string.

FindReplaceStrings(
     SearchString,    ! (input) a scalar string expression
     Key,             ! (input) a scalar string expression
     Replacement,     ! (input) a scalar string expression
     [CaseSensitive], ! (optional) binary
     [WordOnly]       ! (optional) binary
     )

Arguments

SearchString

The string in which you want to find the substring key.

Key

The substring to search for.

Replacement

The string used to replace Key.

CaseSensitive

The search will be case sensitive when the value is 1. The default depends on the setting of the option Case_sensitive_string_comparison, and is 1 if this option is ‘On’ and 0 if this option is ‘Off’. The default of the option Case_sensitive_string_comparison is ‘On’.

WordOnly

It is a word only search when this option is set to 1. The default is 0.

Note

As with all string comparisons within AIMMS, the function FindReplaceStrings is case sensitive by default. You can modify this behavior through the option Case_Sensitive_String_Comparison.

Return Value

The function returns the resulting string. If Key is not found, the original string is returned.

Example

Given the declarations:

StringParameter sp_str;
StringParameter sp_key;
StringParameter sp_rep;
StringParameter sp_res;

And a bit of data:

sp_str := "Hello Hello";
sp_key := "Hello";
sp_rep := "'Allo";

The code:

sp_res := FindReplaceStrings(
        SearchString  :  sp_str,
        Key           :  sp_key,
        Replacement   :  sp_rep,
        CaseSensitive :  1,
        WordOnly      :  0);
display sp_res  ;

will produce the following in the listing file:

sp_res := "'Allo 'Allo" ;

Indicating that both “Hello” words are replaced by the string “‘Allo” ;

See also

The functions FindString, StringOccurrences and FindReplaceNthString.