User Guide

806 Chapter 2:
String.substr()
Availability
Flash Player 5.
Usage
my_str.substr(start:Number, [length:Number]) : String
Parameters
start
A number; an integer that indicates the position of the first character in my_str to be
used to create the substring. If
start is a negative number, the starting position is determined
from the end of the string, where the -1 is the last character.
length A number; the number of characters in the substring being created. If length is not
specified, the substring includes all the characters from the start to the end of the string.
Returns
A string; a substring of the specified string.
Description
Method; returns the characters in a string from the index specified in the start parameter
through the number of characters specified in the
length parameter. The substr method does
not change the string specified by
my_str; it returns a new string.
Example
The following example creates a new string, my_str and uses substr() to return the second word
in the string; first, using a positive
start parameter, and then using a negative start parameter:
var my_str:String = new String("Hello world");
var mySubstring:String = new String();
mySubstring = my_str.substr(6,5);
trace(mySubstring); // output: world
mySubstring = my_str.substr(-5,5);
trace(mySubstring); // output: world
An example is also in the Strings.fla file in the HelpExamples folder. The following list gives
typical paths to this folder:
• Windows: \Program Files\Macromedia\Flash MX 2004\Samples\HelpExamples\
• Macintosh: HD/Applications/Macromedia Flash MX 2004/Samples/HelpExamples/
•