Flash 8 Documentation

ActionScript 2.0 Language Reference > ActionScript language elements > Statements > return statement

return statement

return[expression]

Specifies the value returned by a function. The return statement evaluates expressionand 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.

Availability: ActionScript 1.0; Flash Player 5

Returns

String - The evaluated expression parameter, if provided.

Parameters

expression - A string, number, Boolean, array, or object to evaluate and return as a value of the function. This parameter is optional.

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 statement

Version 8

RSS feed | Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/flash/8/main/00001882.html

Add Comment