StrOverlay

Overlays a new string onto an existing string. (Windows NT and newer)

Syntax:

StrOverlay (base-string, new-string, [pad-string [, start [, length]]])

Parameters:

(s) base-string: specifies the existing string.

(s) new-string: specifies the string to be overlaid onto "base-string".

(s) pad-string: (optional) specifies a character or string to be used for padding, if necessary.  The default is a space (' ').

(i) start: (optional) specifies the position in "base-string" after which "new-string" is to be overlaid, where the position of the first character of the string is 1.  You can specify -1 to overlay after the end of "base-string".  If "start" is past the end of "base-string", padding will be inserted between the end of "base-string" and the beginning of "new-string".  The default is 1.

(i) length: (optional) specifies the number of characters to overlay.  If "length" is shorter than the length of "new-string", "new-string" will be truncated.  If "length" is longer than the length of "new-string", padding will be overlaid after the end of "new-string".  The default is the length of "new-string".

Returns:

(s) the modified string.

Example:

 
Name = "Joe"
ret = StrOverlay ( "Hello my name is ", name, " ", -1 , StrLen( name) )
Message( "StrOverlay () Example", ret )

 

See Also:

StrCharCount, StrByteCount, StrFill, StrFix, StrIndex, StrInsert, StrIndexNc, StrScan, StrTrim, StrTrimChar