Insert (String function)

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

Insert is available as of version 7.6 of the Sirius Mods.

Insert syntax

  %outStr = string:Insert(%insrtString, %before)                                                        

Syntax Terms

%outStr

A string variable to receive the modified method object string.

string

The input string or Longstring.

%insrtString

The byte number in the method object that is the starting point of the substring that is returned.

%before

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 %before must be between 1 and the number of characters in the method object string plus one. An invalid position produces a request cancellation.

Examples

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

List of intrinsic String methods