NAME
return — return
from a function
SYNOPSIS
return |
[n] |
DESCRIPTION
The return utility shall cause the shell
to stop executing the current function or dot(1) script.
If the shell is not currently executing a function or
dot(1) script, the results are unspecified.
OPTIONS
None.
OPERANDS
See the DESCRIPTION.
STDIN
Not used.
INPUT FILES
None.
ENVIRONMENT VARIABLES
None.
ASYNCHRONOUS EVENTS
Default.
STDOUT
Not used.
STDERR
The standard error shall be used only for diagnostic messages.
OUTPUT FILES
None.
EXTENDED DESCRIPTION
None.
EXIT STATUS
The value of the special parameter
‘’? shall be set to
n, an unsigned decimal integer, or to the exit status of
the last command executed if n is not specified. If the
value of n is greater than 255, the results are undefined.
When return is executed in a
trap(1) action, the last command is considered to be the
command that executed immediately preceding the trap(1)
action.
CONSEQUENCES OF ERRORS
Default.
APPLICATION USAGE
None.
EXAMPLES
None.
RATIONALE
The behavior of return when not in a
function or dot(1) script differs between the System V
shell and the KornShell. In the System V shell this is an error, whereas in
the KornShell, the effect is the same as exit(1).
The results of returning a number greater than 255 are undefined because of differing practices in the various historical implementations. Some shells AND out all but the low-order 8 bits; others allow larger values, but not of unlimited size.
See the discussion of appropriate exit status values under exit(1).
FUTURE DIRECTIONS
None.
SEE ALSO
CHANGE HISTORY
Issue 6
IEEE Std 1003.1-2001 (“POSIX.1”)/Cor 1-2002, item XCU/TC1/D6/5 is applied so that the reference page sections use terms as described in the Utility Description Defaults ( xcu_chap01(1)). No change in behavior is intended.
End of informative text. footer end