tcl/doc/AllowExc.3

   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$
   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 *doublePtr
  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 TCL_OK, TCL_CONTINUE
  31 or TCL_RETURN, then Tcl normally converts this into a TCL_ERROR
  32 return with an appropriate message.
  33 .PP
  34 However, if \fBTcl_AllowExceptions\fR is invoked immediately before
  35 calling a procedure such as \fBTcl_Eval\fR, then arbitrary completion
  36 codes are permitted from the script, and they are returned without
  37 modification.
  38 This is useful in cases where the caller can deal with exceptions
  39 such as TCL_BREAK or TCL_CONTINUE in a meaningful way.
  40
  41 .SH KEYWORDS
  42 continue, break, exception, interpreter