2006-10-31 15:23:16 +00:00
|
|
|
\section return return - stop the innermost currently evaluated function
|
2005-09-20 13:31:55 +00:00
|
|
|
|
|
|
|
|
\subsection return-synopsis Synopsis
|
2006-09-19 14:52:03 +00:00
|
|
|
<tt>function NAME; [COMMANDS...;] return [STATUS]; [COMMANDS...;] end</tt>
|
2005-09-20 13:31:55 +00:00
|
|
|
|
2010-09-18 02:18:26 +00:00
|
|
|
\subsection return-description Description
|
2005-09-20 13:31:55 +00:00
|
|
|
|
2006-06-12 16:48:54 +00:00
|
|
|
The \c return builtin is used to halt a currently running function. It
|
|
|
|
|
is usually added inside of a conditional block such as an <a
|
|
|
|
|
href="#if">if</a> statement or a <a href="#switch">switch</a>
|
|
|
|
|
statement to conditionally stop the executing function and return to
|
|
|
|
|
the caller, but it can also be used to specify the exit status of a
|
|
|
|
|
function.
|
|
|
|
|
|
|
|
|
|
- \c STATUS is the return status of the function. If unspecified, the status is unchanged.
|
2005-09-20 13:31:55 +00:00
|
|
|
|
|
|
|
|
\subsection return-example Example
|
2006-06-03 23:15:17 +00:00
|
|
|
The following code is an implementation of the false command as a fish function
|
2006-09-19 14:52:03 +00:00
|
|
|
|
|
|
|
|
<pre>
|
|
|
|
|
function false
|
2005-09-20 13:31:55 +00:00
|
|
|
return 1
|
2006-09-19 14:52:03 +00:00
|
|
|
end
|
|
|
|
|
</pre>
|
|
|
|
|
|
2005-09-20 13:31:55 +00:00
|
|
|
|
