Insert (String function)

From m204wiki
Revision as of 06:29, 31 January 2011 by Goff (talk | contribs) (first pass, match syntax diagram to template and fix tags)
Jump to navigation Jump to search

Insert argument string inside the method object string (String class)


Insert is an intrinsic function that inserts an argument string inside the method object string, starting before the specified position in the method object string.

Syntax

%outString = string:Insert( insertedString, position)

Syntax terms

%string A string variable to receive the modified method object string.
string The input string
insrtString The byte number in the method object that is the starting point of the substring that is returned.
position The numeric value of the position in the method object string before which to insert insrtString. The first character from the left in the method object is position 1. The value of position must be between 1 and the number of characters in the method object string plus one. An invalid position produces a request cancellation.

Usage Notes

  • Insert is available as of Sirius Mods version 7.6.

Examples

  1. The following request contains four Insert method calls:

    begin printText {~} = {:insert('xyz', 1)} printText {~} = {'ABC':insert('xyz', 3)} printText {~} = {'ABC':insert('xyz', 4)} printText {~} = {'ABC':insert('xyz', 5)} End

    The request result is:

    :insert('xyz', 1) = xyz 'abc':insert('xyz', 3) = ABxyzC 'abc':insert('xyz', 4) = ABCxyz 'abc':insert('xyz', 5) = *** 1 CANCELLING REQUEST: MSIR.0750: Class STRING, function INSERT: insertion position greater than length of input string plus one in line 5

See also