return

Availability

Flash Player 5.

Usage

return[expression]
return

Parameters

expression A string, number, 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

Action; specifies the value returned by a function. The return action evaluates expression and returns the result as a value of the function in which it executes. The return action causes the function to stop running and replaces the function with the returned value. If the return statement is used alone, it returns null.

Example

The following example uses the return action inside the body of the sum function to return the added value of the three parameters. The next line of code calls the sum function and assigns the returned value to the variable newValue:

function sum(a, b, c){
	return a + b + c;
}
newValue = sum(4, 32, 78);
trace(newValue);
// sends 114 to the Output window

See also

function