string.SubString()

Syntax

string string.SubString(int start-index, int substring-length)

Parameters

Parameter	Type	Description
start-index (required)	int	The zero-based index of the first character to be returned.
substring-length (required)	int	The length of the string to be extracted.

Returns

A substring of the string starting at the specified start-index parameter, and having the specified length.

Remarks

The method throws an error at runtime if you pass it a negative number for either parameter, a start-index grater or equal to the length of the string, or if the sum of the two parameters exceeds the length of the string.

Sample

stringSample.rfs

var str = "My hovercraft is full of eels.";
...
var d = str.SubString(3, 10);
trace d, d, d;

"hovercraft", "hovercraft", "hovercraft"

Figure 330. The trace message output of the script above

Developer Documentation

The string data type