return (n)
Return from a procedure
SYNOPSIS
return ?-code code? ?-errorinfo info? ?-errorcode code? ?string?
DESCRIPTION
Return immediately from the current procedure
(or top-level command or source command),
with string as the return value. If string is not specified then
an empty string will be returned as result.
EXCEPTIONAL RETURNS
In the usual case where the -code option isn't
specified the procedure will return normally (its completion
code will be TCL_OK).
However, the -code option may be used to generate an
exceptional return from the procedure.
Code may have any of the following values:
ok
Normal return: same as if the option is omitted.
error
Error return: same as if the error command were used to
terminate the procedure, except for handling of errorInfo
and errorCode variables (see below).
return
The current procedure will return with a completion code of
TCL_RETURN, so that the procedure that invoked it will return
also.
break
The current procedure will return with a completion code of
TCL_BREAK, which will terminate the innermost nested loop in
the code that invoked the current procedure.
continue
The current procedure will return with a completion code of
TCL_CONTINUE, which will terminate the current iteration of
the innermost nested loop in the code that invoked the current
procedure.
value
Value must be an integer; it will be returned as the
completion code for the current procedure.
The -code option is rarely used.
It is provided so that procedures that implement
new control structures can reflect exceptional conditions back to
their callers.
Two additional options, -errorinfo and -errorcode,
may be used to provide additional information during error
returns.
These options are ignored unless code is error.
The -errorinfo option specifies an initial stack
trace for the errorInfo variable; if it is not specified then
the stack trace left in errorInfo will include the call to
the procedure and higher levels on the stack but it will not include
any information about the context of the error within the procedure.
Typically the info value is supplied from the value left
in errorInfo after a catch command trapped an error within
the procedure.
If the -errorcode option is specified then code provides
a value for the errorCode variable.
If the option is not specified then errorCode will
default to NONE.
KEYWORDS
break, continue, error, procedure, return
'\"
'\" Copyright (c) 1995-1996 Sun Microsystems, Inc.
'\"
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
'\" RCS: @(#) $Id: safe.n,v 1.2 1998/09/14 18:39:55 stanton Exp $
'\"
'\" The definitions below are for supplemental macros used in Tcl/Tk
'\" manual entries.
'\"
'\" .AP type name in/out ?indent?
'\" Start paragraph describing an argument to a library procedure.
'\" type is type of argument (int, etc.), in/out is either "in", "out",
'\" or "in/out" to describe whether procedure reads or modifies arg,
'\" and indent is equivalent to second arg of .IP (shouldn't ever be
'\" needed; use .AS below instead)
'\"
'\" .AS ?type? ?name?
'\" Give maximum sizes of arguments for setting tab stops. Type and
'\" name are examples of largest possible arguments that will be passed
'\" to .AP later. If args are omitted, default tab stops are used.
'\"
'\" .BS
'\" Start box enclosure. From here until next .BE, everything will be
'\" enclosed in one large box.
'\"
'\" .BE
'\" End of box enclosure.
'\"
'\" .CS
'\" Begin code excerpt.
'\"
'\" .CE
'\" End code excerpt.
'\"
'\" .VS ?version? ?br?
'\" Begin vertical sidebar, for use in marking newly-changed parts
'\" of man pages. The first argument is ignored and used for recording
'\" the version when the .VS was added, so that the sidebars can be
'\" found and removed when they reach a certain age. If another argument
'\" is present, then a line break is forced before starting the sidebar.
'\"
'\" .VE
'\" End of vertical sidebar.
'\"
'\" .DS
'\" Begin an indented unfilled display.
'\"
'\" .DE
'\" End of indented unfilled display.
'\"
'\" .SO
'\" Start of list of standard options for a Tk widget. The
'\" options follow on successive lines, in four columns separated
'\" by tabs.
'\"
'\" .SE
'\" End of list of standard options for a Tk widget.
'\"
'\" .OP cmdName dbName dbClass
'\" Start of description of a specific option. cmdName gives the
'\" option's name as specified in the class command, dbName gives
'\" the option's name in the option database, and dbClass gives
'\" the option's class in the option database.
'\"
'\" .UL arg1 arg2
'\" Print arg1 underlined, then print arg2 normally.
'\"
'\" RCS: @(#) $Id: man.macros,v 1.2 1998/09/14 18:39:54 stanton Exp $
'\"
'\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
t .wh -1.3i ^B
^l \n(.l
b
'\" # Start an argument description
AP
!"\\$4"" .TP \\$4
\{\
!"\\$2"" .TP \\n()Cu
.TP 15
|
|