2 '\" Copyright (c
) 1993 The Regents of the University of California
.
3 '\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
5 '\" See the file "license.terms" for information on usage and redistribution
6 '\" of
this file
, and for a DISCLAIMER OF ALL WARRANTIES
.
8 '\" RCS
: @
(#) $Id: return.n,v 1.1 2003/12/20 03:31:54 bbbush Exp $
10 '\" The definitions below are
for supplemental macros used
in Tcl
/Tk
13 '\" .AP type name in/out ?indent?
14 '\" Start paragraph describing an argument to a library procedure
.
15 '\" type is type of argument (int, etc.), in/out is either "in", "out",
16 '\" or
"in/out" to describe whether procedure reads or modifies arg
,
17 '\" and indent is equivalent to second arg of .IP (shouldn't ever be
18 '\" needed; use .AS below instead)
21 '\" Give maximum sizes of arguments
for setting tab stops
. Type
and
22 '\" name are examples of largest possible arguments that will be passed
23 '\" to
.AP later
. If args are omitted
, default tab stops are used
.
26 '\" Start box enclosure. From here until next .BE, everything will be
27 '\" enclosed
in one large box
.
30 '\" End of box enclosure.
33 '\" Begin code excerpt
.
38 '\" .VS ?version? ?br?
39 '\" Begin vertical sidebar
, for use
in marking newly
-changed parts
40 '\" of man pages. The first argument is ignored and used for recording
41 '\" the version
when the
.VS was added
, so that the sidebars can be
42 '\" found and removed when they reach a certain age. If another argument
43 '\" is present
, then a line break is forced before starting the sidebar
.
46 '\" End of vertical sidebar.
49 '\" Begin an indented unfilled display
.
52 '\" End of indented unfilled display.
55 '\" Start of
list of standard options
for a Tk widget
. The
56 '\" options follow on successive lines, in four columns separated
60 '\" End of list of standard options for a Tk widget.
62 '\" .OP cmdName dbName dbClass
63 '\" Start of description of a specific option
. cmdName gives the
64 '\" option's name
as specified
in the
class command
, dbName gives
65 '\" the option's name
in the option database
, and dbClass gives
66 '\" the option's
class in the option database
.
69 '\" Print arg1 underlined, then print arg2 normally.
71 '\" RCS: @(#) $Id: return.n,v 1.1 2003/12/20 03:31:54 bbbush Exp $
73 '\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
77 '\" # Start an argument description
81 . ie !"\\$2
"" .TP
\\n()Cu
86 \&\\$1 \\fI\\$2\\fP (\\$3)
99 '\" # define tabbing values for .AP
102 .if !"\\$1"" .nr )A \\w'\\$1
'u+3n
105 .if !"\\$2"" .nr )B \\w'\\$2
'u+\\n()Au+3n
106 .nr )C \\n()Bu+\\w'(in/out)'u+2n
108 .AS Tcl_Interp Tcl_CreateInterp in/out
109 '\" # BS - start boxed text
110 '\" # ^y = starting y location
118 .if n \l
'\\n(.lu\(ul'
121 '\" # BE - end boxed text (draw box now)
126 .ie n \l'\\n(^lu\
(ul
'
128 .\" Draw four-sided box normally, but don't draw top of
129 .\" box
if the box started on an earlier page
.
131 \h
'-1.5n'\L
'|\\n(^yu-1v'\l
'\\n(^lu+3n\(ul'\L
'\\n(^tu+1v-\\n(^yu'\l
'|0u-1.5n\(ul'
134 \h
'-1.5n'\L
'|\\n(^yu-1v'\h
'\\n(^lu+3n'\L
'\\n(^tu+1v-\\n(^yu'\l
'|0u-1.5n\(ul'
141 '\" # VS - start vertical sidebar
142 '\" # ^Y = starting y location
143 '\" # ^v = 1 (for troff; for nroff this doesn't matter
)
147 .ie n 'mc \s12\(br\s0
150 '\" # VE - end of vertical sidebar
158 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
165 '\" # Special macro to handle page bottom: finish off current
166 '\" # box/sidebar if in box/sidebar mode, then invoked standard
167 '\" # page bottom macro.
174 .\" Draw three-sided box if this is the box's first page,
175 .\" draw two sides but no top otherwise.
176 .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
177 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
180 .nr ^x \\n(^tu+1v-\\n(^Yu
181 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
194 '\" # DS - begin display
200 '\" # DE - end display
206 '\" # SO - start of list of standard options
208 .SH "STANDARD OPTIONS
"
214 '\" # SE - end of list of standard options
219 See the \\fBoptions\\fR manual entry for details on the standard options.
221 '\" # OP - start of full description for a single option
226 Command-Line Name: \\fB\\$1\\fR
227 Database Name: \\fB\\$2\\fR
228 Database Class: \\fB\\$3\\fR
232 '\" # CS - begin code excerpt
238 '\" # CE - end code excerpt
246 .TH return n 7.0 Tcl "Tcl Built
-In Commands
"
248 '\" Note: do not modify the .SH NAME line immediately below!
250 return \- Return from a procedure
252 \fBreturn \fR?\fB\-code \fIcode\fR? ?\fB\-errorinfo \fIinfo\fR? ?\fB\-errorcode\fI code\fR? ?\fIstring\fR?
257 Return immediately from the current procedure
258 (or top-level command or \fBsource\fR command),
259 with \fIstring\fR as the return value. If \fIstring\fR is not specified then
260 an empty string will be returned as result.
262 .SH "EXCEPTIONAL RETURNS
"
264 In the usual case where the \fB\-code\fR option isn't
265 specified the procedure will return normally (its completion
266 code will be TCL_OK).
267 However, the \fB\-code\fR option may be used to generate an
268 exceptional return from the procedure.
269 \fICode\fR may have any of the following values:
272 Normal return: same as if the option is omitted.
275 Error return: same as if the \fBerror\fR command were used to
276 terminate the procedure, except for handling of \fBerrorInfo\fR
277 and \fBerrorCode\fR variables (see below).
280 The current procedure will return with a completion code of
281 TCL_RETURN, so that the procedure that invoked it will return
285 The current procedure will return with a completion code of
286 TCL_BREAK, which will terminate the innermost nested loop in
287 the code that invoked the current procedure.
290 The current procedure will return with a completion code of
291 TCL_CONTINUE, which will terminate the current iteration of
292 the innermost nested loop in the code that invoked the current
296 \fIValue\fR must be an integer; it will be returned as the
297 completion code for the current procedure.
299 The \fB\-code\fR option is rarely used.
300 It is provided so that procedures that implement
301 new control structures can reflect exceptional conditions back to
304 Two additional options, \fB\-errorinfo\fR and \fB\-errorcode\fR,
305 may be used to provide additional information during error
307 These options are ignored unless \fIcode\fR is \fBerror\fR.
309 The \fB\-errorinfo\fR option specifies an initial stack
310 trace for the \fBerrorInfo\fR variable; if it is not specified then
311 the stack trace left in \fBerrorInfo\fR will include the call to
312 the procedure and higher levels on the stack but it will not include
313 any information about the context of the error within the procedure.
314 Typically the \fIinfo\fR value is supplied from the value left
315 in \fBerrorInfo\fR after a \fBcatch\fR command trapped an error within
318 If the \fB\-errorcode\fR option is specified then \fIcode\fR provides
319 a value for the \fBerrorCode\fR variable.
320 If the option is not specified then \fBerrorCode\fR will
321 default to \fBNONE\fR.
324 break(n), continue(n), error(n), proc(n)
327 break, continue, error, procedure, return