User Guide

198 Chapter 5: ActionScript Core Language Elements
return
Availability
Flash Player 5.
Usage
return[expression]
Parameters
expression
A string, number, Boolean, array, or object to evaluate and return as a value of the
function. This parameter is optional.
Returns
The evaluated expression parameter, if provided.
Description
Statement; specifies the value returned by a function. The return statement evaluates
expression and returns the result as a value of the function in which it executes. The return
statement causes execution to return immediately to the calling function. If the
return statement
is used alone, it returns
undefined.
You can’t return multiple values. If you try to do so, only the last value is returned. In the
following example,
c is returned:
return a, b, c ;
If you need to return multiple values, you might want to use an array or object instead.
Example
The following example uses the return statement inside the body of the sum() function to return
the added value of the three parameters. The next line of code calls
sum() and assigns the
returned value to the variable
newValue.
function sum(a:Number, b:Number, c:Number):Number {
return (a+b+c);
}
var newValue:Number = sum(4, 32, 78);
trace(newValue); // output: 114
See also
function
CHAPTER 5
ActionScript Core Language Elements