1 | '\" |
---|
2 | '\" Copyright (c) 1989-1993 The Regents of the University of California. |
---|
3 | '\" Copyright (c) 1994-1996 Sun Microsystems, Inc. |
---|
4 | '\" |
---|
5 | '\" See the file "license.terms" for information on usage and redistribution |
---|
6 | '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. |
---|
7 | '\" |
---|
8 | '\" RCS: @(#) $Id: AllowExc.3,v 1.5 2004/10/07 14:44:31 dkf Exp $ |
---|
9 | '\" |
---|
10 | .so man.macros |
---|
11 | .TH Tcl_AllowExceptions 3 7.4 Tcl "Tcl Library Procedures" |
---|
12 | .BS |
---|
13 | .SH NAME |
---|
14 | Tcl_AllowExceptions \- allow all exceptions in next script evaluation |
---|
15 | .SH SYNOPSIS |
---|
16 | .nf |
---|
17 | \fB#include <tcl.h>\fR |
---|
18 | .sp |
---|
19 | \fBTcl_AllowExceptions\fR(\fIinterp\fR) |
---|
20 | .SH ARGUMENTS |
---|
21 | .AS Tcl_Interp *interp |
---|
22 | .AP Tcl_Interp *interp in |
---|
23 | Interpreter in which script will be evaluated. |
---|
24 | .BE |
---|
25 | |
---|
26 | .SH DESCRIPTION |
---|
27 | .PP |
---|
28 | If a script is evaluated at top-level (i.e. no other scripts are |
---|
29 | pending evaluation when the script is invoked), and if the script |
---|
30 | terminates with a completion code other than \fBTCL_OK\fR, \fBTCL_ERROR\fR |
---|
31 | or \fBTCL_RETURN\fR, then Tcl normally converts this into a \fBTCL_ERROR\fR |
---|
32 | return with an appropriate message. The particular script |
---|
33 | evaluation procedures of Tcl that act in the manner are |
---|
34 | \fBTcl_EvalObjEx\fR, \fBTcl_EvalObjv\fR, \fBTcl_Eval\fR, \fBTcl_EvalEx\fR, |
---|
35 | \fBTcl_GlobalEval\fR, \fBTcl_GlobalEvalObj\fR, \fBTcl_VarEval\fR and |
---|
36 | \fBTcl_VarEvalVA\fR. |
---|
37 | .PP |
---|
38 | However, if \fBTcl_AllowExceptions\fR is invoked immediately before |
---|
39 | calling one of those a procedures, then arbitrary completion |
---|
40 | codes are permitted from the script, and they are returned without |
---|
41 | modification. |
---|
42 | This is useful in cases where the caller can deal with exceptions |
---|
43 | such as \fBTCL_BREAK\fR or \fBTCL_CONTINUE\fR in a meaningful way. |
---|
44 | |
---|
45 | .SH KEYWORDS |
---|
46 | continue, break, exception, interpreter |
---|