diff options
Diffstat (limited to 'doc/catch.n')
| -rw-r--r-- | doc/catch.n | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/doc/catch.n b/doc/catch.n index ddadd34..9592d4c 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.16 2007/10/28 14:17:40 dkf Exp $ +'\" RCS: @(#) $Id: catch.n,v 1.17 2007/10/29 11:28:50 dkf Exp $ '\" .so man.macros .TH catch n "8.5" Tcl "Tcl Built-In Commands" @@ -48,28 +48,28 @@ stored in \fIresultVarName\fR is the value returned from \fIscript\fR. If the \fIoptionsVarName\fR argument is given, then the variable it names is set to a dictionary of return options returned by evaluation of \fIscript\fR. Tcl specifies two entries that are always -defined in the dictionary: \fB-code\fR and \fB-level\fR. When +defined in the dictionary: \fB\-code\fR and \fB\-level\fR. When the return code from evaluation of \fIscript\fR is not \fBTCL_RETURN\fR, -the value of the \fB-level\fR entry will be 0, and the value -of the \fB-code\fR entry will be the same as the return code. +the value of the \fB\-level\fR entry will be 0, and the value +of the \fB\-code\fR entry will be the same as the return code. 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 +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, 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 +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 +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 +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 +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 |