$SubIns

From m204wiki
Revision as of 22:55, 10 October 2014 by JAL (talk | contribs) (→‎Examples)
Jump to navigation Jump to search

Insert string inside another string

Note: Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $SubIns function is Insert.

This function inserts a string inside another.

The $SubIns function accepts three arguments and returns a string result.

Syntax

%string = $SubIns(string, ins_string, insert_pos)

Syntax terms

%string The string result that is a combination of string and ins_string.
string An arbitrary string.
ins_string A string to be inserted in the string value.
insert_pos The insertion position in the string argument string.

Usage notes

  • If no insertion position is provided, the insertion string is appended to the end of the first input string. If the insertion point is past the first input string, the first input string is left unmodified.

Examples

  1. This statement sets %JUNK to PAT STAMPER, TRADER HORSE:

    %JUNK = $SubIns('PAT STAMPER, TRADER', ' HORSE')

  2. This statement sets %JUNK to PAT STAMPER, HORSE TRADER:

    %JUNK = $SubIns('PAT STAMPER, TRADER', ' HORSE', 12)

  3. This statement sets %JUNK to PAT STAMPER, TRADER:

    %JUNK = $SubIns('PAT STAMPER, TRADER', ' HORSE', 92)

Products authorizing $SubIns