return

Arguments

x1,..,xn

variables in calling environment

a1,..,an

local variables

Description

In a function return stops the execution of the function, [x1,..,xn]=return(a1,..,an) stops the execution of the function and put the local variables ai in calling environment under names xi.

In pause mode, it allows to return to upper level. [x1,..,xn]=return(a1,..,an) returns to upper level and put the local variables ai in calling environment under names xi.

In an execstr called by a function [x1,..,xn]=return(a1,..,an) stops the execution of the function and put the local variables ai in calling environment under names xi.

The statement resume is equivalent to return.

Note: the usage of this feature can complexify the code. Instead, the syntax function b=foo() is recommended.

Examples

function foo(a)
         a=a+1
         b=resume(a)
         c=52
endfunction

foo(42);
assert_checkequal(b,43)
// c does not exist

See Also

• abort — interrupt evaluation.
• break — keyword to interrupt loops
• execstr — execute Scilab code in strings
• resume — return or resume execution and copy some local variables