summaryrefslogtreecommitdiff
path: root/tcl/doc/AllowExc.3
diff options
context:
space:
mode:
Diffstat (limited to 'tcl/doc/AllowExc.3')
-rw-r--r--tcl/doc/AllowExc.310
1 files changed, 7 insertions, 3 deletions
diff --git a/tcl/doc/AllowExc.3 b/tcl/doc/AllowExc.3
index d035d0e50d8..9ca0bd79751 100644
--- a/tcl/doc/AllowExc.3
+++ b/tcl/doc/AllowExc.3
@@ -27,12 +27,16 @@ Interpreter in which script will be evaluated.
.PP
If a script is evaluated at top-level (i.e. no other scripts are
pending evaluation when the script is invoked), and if the script
-terminates with a completion code other than TCL_OK, TCL_CONTINUE
+terminates with a completion code other than TCL_OK, TCL_ERROR
or TCL_RETURN, then Tcl normally converts this into a TCL_ERROR
-return with an appropriate message.
+return with an appropriate message. The particular script
+evaluation procedures of Tcl that act in the manner are
+\fBTcl_EvalObjEx\fR, \fBTcl_EvalObjv\fR, \fBTcl_Eval\fR, \fBTcl_EvalEx\fR,
+\fBTcl_GlobalEval\fR, \fBTcl_GlobalEvalObj\fR, \fBTcl_VarEval\fR and
+\fBTcl_VarEvalVA\fR.
.PP
However, if \fBTcl_AllowExceptions\fR is invoked immediately before
-calling a procedure such as \fBTcl_Eval\fR, then arbitrary completion
+calling one of those a procedures, then arbitrary completion
codes are permitted from the script, and they are returned without
modification.
This is useful in cases where the caller can deal with exceptions