diff options
| author | dgp <dgp@users.sourceforge.net> | 2008-12-15 18:33:24 (GMT) |
|---|---|---|
| committer | dgp <dgp@users.sourceforge.net> | 2008-12-15 18:33:24 (GMT) |
| commit | 4a44a570aada5b04e9ffdee9b9f82f7fa34cfe6c (patch) | |
| tree | d0ed3407fd1898930f5bc28d45d09c610c8775cb /doc/SetResult.3 | |
| parent | fc8e6478bfb02d60c1dc8c861dd80af63e036481 (diff) | |
| download | tcl-4a44a570aada5b04e9ffdee9b9f82f7fa34cfe6c.zip tcl-4a44a570aada5b04e9ffdee9b9f82f7fa34cfe6c.tar.gz tcl-4a44a570aada5b04e9ffdee9b9f82f7fa34cfe6c.tar.bz2 | |
* doc/AddErrInfo.3: Documented Tcl_(Set|Get)ErrorLine (TIP 336).
* doc/CrtCommand.3: Various other documentation updates to
* doc/CrtInterp.3: reflect the lack of access to Tcl_Interp fields
* doc/Interp.3: by default.
* doc/SetResult.3:
* doc/tcl.decls:
Diffstat (limited to 'doc/SetResult.3')
| -rw-r--r-- | doc/SetResult.3 | 19 |
1 files changed, 11 insertions, 8 deletions
diff --git a/doc/SetResult.3 b/doc/SetResult.3 index d19bd998..12ccc90 100644 --- a/doc/SetResult.3 +++ b/doc/SetResult.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: SetResult.3,v 1.23 2008/12/05 16:01:01 nijtmans Exp $ +'\" RCS: @(#) $Id: SetResult.3,v 1.24 2008/12/15 18:33:25 dgp Exp $ '\" .so man.macros .TH Tcl_SetResult 3 8.0 Tcl "Tcl Library Procedures" @@ -199,16 +199,19 @@ It also sets \fIinterp->freeProc\fR to zero, but does not change \fIinterp->result\fR or clear error state. \fBTcl_FreeResult\fR is most commonly used when a procedure is about to replace one result value with another. -.SS "DIRECT ACCESS TO INTERP->RESULT IS DEPRECATED" +.SS "DIRECT ACCESS TO INTERP->RESULT" .PP It used to be legal for programs to directly read and write \fIinterp->result\fR -to manipulate the interpreter result. -Direct access to \fIinterp->result\fR is now strongly deprecated -because it can make the result's string and object forms inconsistent. -Programs should always read the result -using the procedures \fBTcl_GetObjResult\fR or \fBTcl_GetStringResult\fR, -and write the result using \fBTcl_SetObjResult\fR or \fBTcl_SetResult\fR. +to manipulate the interpreter result. The Tcl headers no longer +permit this access by default, and C code still doing this must +be updated to use supported routines \fBTcl_GetObjResult\fR, +\fBTcl_GetStringResult\fR, \fBTcl_SetObjResult\fR, and \fBTcl_SetResult\fR. +As a migration aid, access can be restored with the compiler directive +.CS +#define USE_INTERP_RESULT +.CE +but this is meant only to offer life support to otherwise dead code. .SH "THE TCL_FREEPROC ARGUMENT TO TCL_SETRESULT" .PP \fBTcl_SetResult\fR's \fIfreeProc\fR argument specifies how |