diff options
| author | dgp <dgp@users.sourceforge.net> | 2004-11-20 00:17:28 (GMT) |
|---|---|---|
| committer | dgp <dgp@users.sourceforge.net> | 2004-11-20 00:17:28 (GMT) |
| commit | ff53303dbf5fc75eea7bb3d9bc569267adb1d49b (patch) | |
| tree | 37544eb5529a0eb1f2f1a0f46ad94a43354cc96b /doc/return.n | |
| parent | 2c96347f634403dffaf0ecf177118cd8202af841 (diff) | |
| download | tcl-ff53303dbf5fc75eea7bb3d9bc569267adb1d49b.zip tcl-ff53303dbf5fc75eea7bb3d9bc569267adb1d49b.tar.gz tcl-ff53303dbf5fc75eea7bb3d9bc569267adb1d49b.tar.bz2 | |
* doc/AddErrInfo.3: Docs for Tcl_(Get|Set)ReturnOptions. [TIP 227]
* doc/AddErrInfo.3:
* doc/Async.3: Documentation updates to replace references
* doc/BackgdErr.3: to global variable ::errorInfo and ::errorCode
* doc/SaveResult.3: and to the ::bgerror command with references
* doc/after.n: to their preferred replacements, the
* doc/bgerror.n: -errorinfo and -errorcode return options,
* doc/error.n: the Tcl_*InterpState routines, and the
* doc/exec.n: [interp bgerror] command.
* doc/exit.n:
* doc/fileevent.n:
* doc/interp.n:
* doc/return.n:
* doc/tclvars.n:
* doc/update.n:
Diffstat (limited to 'doc/return.n')
| -rw-r--r-- | doc/return.n | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/return.n b/doc/return.n index e08dc05..1f884e9 100644 --- a/doc/return.n +++ b/doc/return.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: return.n,v 1.11 2004/10/27 14:24:37 dkf Exp $ +'\" RCS: @(#) $Id: return.n,v 1.12 2004/11/20 00:17:32 dgp Exp $ '\" .so man.macros .TH return n 8.5 Tcl "Tcl Built-In Commands" @@ -106,14 +106,14 @@ recognized and treated specially by Tcl. They are: .TP \fB-errorcode \fIlist\fR The \fB-errorcode\fR option receives special treatment only when the value -of the \fB-code\fR option is \fBTCL_ERROR\fR. Then the \fIlist\fR value, which -must be a valid Tcl list, is stored in the global variable \fBerrorCode\fR. -The \fIlist\fR value is meant to be additional information about the error, +of the \fB-code\fR option is \fBTCL_ERROR\fR. Then the \fIlist\fR value +is meant to be additional information about the error, presented as a Tcl list for further processing by programs. If no \fB-errorcode\fR option is provided to \fBreturn\fR when the \fB-code error\fR option is provided, Tcl will set the value -of both the \fB-errorcode\fR entry in the return options dictionary and -the global variable \fBerrorCode\fR to the default value of \fBNONE\fR. +of the \fB-errorcode\fR entry in the return options dictionary +to the default value of \fBNONE\fR. The \fB-errorcode\fR return +option will also be stored in the global variable \fBerrorCode\fR. .TP \fB-errorinfo \fIinfo\fR The \fB-errorinfo\fR option receives special treatment only when the value |