diff options
Diffstat (limited to 'doc/catch.n')
| -rw-r--r-- | doc/catch.n | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/doc/catch.n b/doc/catch.n index cc5d4bc..4414893 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.10 2004/08/31 15:19:35 dkf Exp $ +'\" RCS: @(#) $Id: catch.n,v 1.11 2004/09/18 17:01:06 dkf Exp $ '\" .so man.macros .TH catch n "8.5" Tcl "Tcl Built-In Commands" @@ -28,10 +28,10 @@ regardless of any errors that might occur while executing \fIscript\fR. If \fIscript\fR raises an error, \fBcatch\fR will return a non-zero integer value corresponding to the exceptional return code returned by evaluation of \fIscript\fR. Tcl defines the normal return code from script -evaluation to be zero (0), or TCL_OK. Tcl also defines four exceptional -return codes: 1 (TCL_ERROR), 2 (TCL_RETURN), 3 (TCL_BREAK), -and 4 (TCL_CONTINUE). Errors during evaluation of a script are indicated -by a return code of TCL_ERROR. The other exceptional return codes are +evaluation to be zero (0), or \fBTCL_OK\fR. Tcl also defines four exceptional +return codes: 1 (\fBTCL_ERROR\fR), 2 (\fBTCL_RETURN\fR), 3 (\fBTCL_BREAK\fR), +and 4 (\fBTCL_CONTINUE\fR). Errors during evaluation of a script are indicated +by a return code of \fBTCL_ERROR\fR. The other exceptional return codes are returned by the \fBreturn\fR, \fBbreak\fR, and \fBcontinue\fR commands and in other special situations as documented. Tcl packages can define new commands that return other integer values as return codes as well, @@ -40,8 +40,8 @@ have return codes other than the five defined by Tcl. .PP If the \fIresultVarName\fR argument is given, then the variable it names is set to the result of the script evaluation. When the return code from -the script is TCL_ERROR, the value stored in \fIresultVarName\fR is an error -message. When the return code from the script is TCL_OK, the value +the script is \fBTCL_ERROR\fR, the value stored in \fIresultVarName\fR is an error +message. When the return code from the script is \fBTCL_OK\fR, the value stored in \fIresultVarName\fR is the value returned from \fIscript\fR. .VS 8.5 .PP @@ -49,14 +49,14 @@ 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 -the return code from evaluation of \fIscript\fR is not TCL_RETURN, +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. -Only when the return code is TCL_RETURN will the values of +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 TCL_ERROR, +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 |