$SubRep

Replace occurrences of string

Note: Most Sirius $functions have been deprecated in favor of Object Oriented methods. The recommended OO replacement function for $SubRep is Replace. (See the Usage notes below.)

This function replaces occurrences of a substring in one string with another.

The $SubRep function accepts five arguments and returns a string result that is part of the first argument string.

Syntax

%string = $SubRep(string, substring, repstring, [start_pos], [count])

Syntax terms

%string	The part of the first argument string that remains after the replacements of substring by repstring.
string	An arbitrary string.
substring	An arbitrary string located in the string argument value.
repstring	A replacement string.
start_pos	A starting position in the string argument string. This optional argument defaults to 1.
count	A repeat count indicating the number of occurrences to be replaced. This optional argument defaults to 1.

Usage notes

• As stated above, the recommended OO replacement function for $SubRep is Replace. However, unlike $SubRep, Replace is Longstring capable (like all OO methods), so:
  • Both $SubRep and Replace have an optional argument for the count of substrings to replace, but their defaults differ: for $SubRep it is 1; Replace replaces all instances of the substring.
  • It is possible that an application using $SubRep is unintentionally using "silent truncation," which will become noticable if you replace it with Replace; see the discussion in Longstrings.
  • Do not replace Replace with $SubRep.
• If the substitution would cause the result value to exceed 255 characters, it is not performed.

Examples

1. This statement sets %JUNK to XYCDABAB:

   %JUNK = $SubRep('ABCDABAB', 'AB', 'XY')

2. This statement sets %JUNK to XYCDXYXY:

   %JUNK = $SubRep('ABCDABAB', 'AB', 'XY', ,5)

3. This statement sets %JUNK to ABCDXYXY.

   %JUNK = $SubRep('ABCDABAB', 'AB', 'XY', 3 ,5)

Products authorizing $SubRep

• Sirius functions
• Fast/Unload User Language Interface
• Janus Open Client
• Janus Open Server
• Janus Sockets
• Janus Web Server
• Japanese functions
• Sir2000 Field Migration Facility