diff options
Diffstat (limited to 'doc/catch.n')
| -rw-r--r-- | doc/catch.n | 45 |
1 files changed, 17 insertions, 28 deletions
diff --git a/doc/catch.n b/doc/catch.n index f06220b..1c617b3 100644 --- a/doc/catch.n +++ b/doc/catch.n @@ -6,7 +6,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: catch.n,v 1.21 2009/11/16 17:38:08 ferrieux Exp $ +'\" RCS: @(#) $Id: catch.n,v 1.22 2009/11/16 18:00:11 dgp Exp $ '\" .so man.macros .TH catch n "8.5" Tcl "Tcl Built-In Commands" @@ -54,33 +54,22 @@ Only when the return code is \fBTCL_RETURN\fR will the values of the \fB\-level\fR and \fB\-code\fR entries be something else, as further described in the documentation for the \fBreturn\fR command. .PP -When the return code from evaluation of \fIscript\fR is -\fBTCL_ERROR\fR, four additional entries are defined in the dictionary -of return options stored in \fIoptionsVarName\fR: \fB\-errorinfo\fR, -\fB\-errorcode\fR, \fB\-errorline\fR, and \fB\-errorstack\fR. The -value of the \fB\-errorinfo\fR entry is a formatted stack trace -containing more information about the context in which the error -happened. The formatted stack trace is meant to be read by a person. -The value of the \fB\-errorcode\fR entry is additional information -about the error stored as a list. The \fB\-errorcode\fR value is -meant to be further processed by programs, and may not be particularly -readable by people. The value of the \fB\-errorline\fR entry is an -integer indicating which line of \fIscript\fR was being evaluated when -the error occurred. The value of the \fB\-errorstack\fR entry is a -list of lists made of the function names and arguments at each level -from the call stack when the error occurred. It differs from --errorinfo in that (1) it is a true list of lists, for easy -programmatic access without parsing, (2) it contains the true -(substituted) values passed to the functions, instead of the static -text of the calling sites, and (3) it is coarser-grained, with only -one element per stack frame (like procs; no separate elements for -[foreach] constructs for example). - -The values of the \fB\-errorinfo\fR and \fB\-errorcode\fR entries of -the most recent error are also available as values of the global -variables \fB::errorInfo\fR and \fB::errorCode\fR respectively. The -value of the \fB\-errorstack\fR entry surfaces as \fBinfo -errorstack\fR. +When the return code from evaluation of \fIscript\fR is \fBTCL_ERROR\fR, +three additional entries are defined in the dictionary of return options +stored in \fIoptionsVarName\fR: \fB\-errorinfo\fR, \fB\-errorcode\fR, +and \fB\-errorline\fR. The value of the \fB\-errorinfo\fR entry +is a formatted stack trace containing more information about +the context in which the error happened. The formatted stack +trace is meant to be read by a person. The value of +the \fB\-errorcode\fR entry is additional information about the +error stored as a list. The \fB\-errorcode\fR value is meant to +be further processed by programs, and may not be particularly +readable by people. The value of the \fB\-errorline\fR entry +is an integer indicating which line of \fIscript\fR was being +evaluated when the error occurred. The values of the \fB\-errorinfo\fR +and \fB\-errorcode\fR entries of the most recent error are also +available as values of the global variables \fB::errorInfo\fR +and \fB::errorCode\fR respectively. .PP Tcl packages may provide commands that set other entries in the dictionary of return options, and the \fBreturn\fR command may be |