Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

Tcl_AllowExceptions (3tcl)

Name

Tcl_AllowExceptions - allow all exceptions in next script evaluation

Synopsis

#include <tcl.h>

Tcl_AllowExceptions(interp)

Description

Tcl_AllowExceptions(3tcl)   Tcl Library Procedures   Tcl_AllowExceptions(3tcl)



______________________________________________________________________________

NAME
       Tcl_AllowExceptions - allow all exceptions in next script evaluation

SYNOPSIS
       #include <tcl.h>

       Tcl_AllowExceptions(interp)

ARGUMENTS
       Tcl_Interp *interp (in)          Interpreter  in  which  script will be
                                        evaluated.
______________________________________________________________________________


DESCRIPTION
       If a script is evaluated at top-level (i.e. no other scripts are  pend-
       ing  evaluation  when  the script is invoked), and if the script termi-
       nates  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.  The particular script  evaluation  proce-
       dures  of  Tcl  that act in the manner are Tcl_EvalObjEx, Tcl_EvalObjv,
       Tcl_Eval, Tcl_EvalEx,  Tcl_GlobalEval,  Tcl_GlobalEvalObj,  Tcl_VarEval
       and Tcl_VarEvalVA.

       However,  if  Tcl_AllowExceptions is invoked immediately before calling
       one of those a procedures, then arbitrary completion codes are  permit-
       ted  from the script, and they are returned without modification.  This
       is useful in cases where the caller can deal with  exceptions  such  as
       TCL_BREAK or TCL_CONTINUE in a meaningful way.


KEYWORDS
       continue, break, exception, interpreter



ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | runtime/tcl-8    |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

NOTES
       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source was downloaded from  http://prdownloads.sourceforge.net/tcl/tcl-
       core8.6.7-src.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.tcl.tk/.



Tcl                                   7.4            Tcl_AllowExceptions(3tcl)