$SubIns

From m204wiki
Revision as of 20:26, 8 February 2011 by Alan (talk | contribs)
Jump to navigation Jump to search

<section begin="desc" />Insert string inside another string<section end="desc" />

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

This function inserts a string inside another.

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

The first argument is an arbitrary string.

The second argument is another arbitrary string.

The third argument is an insertion position in the first argument string.

Syntax

<section begin="syntax" /> %STRING = $SubIns(string, ins_string, insert_pos) <section end="syntax" />

$SubIns Function

%STRING is a string made up of string and ins_string.

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.

For example, this statement sets %JUNK to PAT STAMPER, TRADER HORSE:

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

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

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

This statement sets %JUNK to PAT STAMPER, TRADER:

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

Products authorizing $SubIns