diff options
| author | dgp@users.sourceforge.net <dgp> | 2008-12-15 18:33:24 (GMT) |
|---|---|---|
| committer | dgp@users.sourceforge.net <dgp> | 2008-12-15 18:33:24 (GMT) |
| commit | 9cedb36cd3641eb6b6c99a8331decbb86c990d26 (patch) | |
| tree | d0ed3407fd1898930f5bc28d45d09c610c8775cb /doc/Interp.3 | |
| parent | ead691e097dd719a222b3c37b2ab506808d05e23 (diff) | |
| download | tcl-9cedb36cd3641eb6b6c99a8331decbb86c990d26.zip tcl-9cedb36cd3641eb6b6c99a8331decbb86c990d26.tar.gz tcl-9cedb36cd3641eb6b6c99a8331decbb86c990d26.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/Interp.3')
| -rw-r--r-- | doc/Interp.3 | 28 |
1 files changed, 19 insertions, 9 deletions
diff --git a/doc/Interp.3 b/doc/Interp.3 index 29c2c65..4f0a250 100644 --- a/doc/Interp.3 +++ b/doc/Interp.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: Interp.3,v 1.14 2008/06/29 22:28:24 dkf Exp $ +'\" RCS: @(#) $Id: Interp.3,v 1.15 2008/12/15 18:33:25 dgp Exp $ '\" .so man.macros .TH Tcl_Interp 3 7.5 Tcl "Tcl Library Procedures" @@ -28,15 +28,25 @@ typedef void \fBTcl_FreeProc\fR( .SH DESCRIPTION .PP The \fBTcl_CreateInterp\fR procedure returns a pointer to a Tcl_Interp -structure. This pointer is then passed into other Tcl procedures -to process commands in the interpreter and perform other operations -on the interpreter. Interpreter structures contain many fields -that are used by Tcl, but only three that may be accessed by -clients: \fIresult\fR, \fIfreeProc\fR, and \fIerrorLine\fR. +structure. Callers of \fBTcl_CreateInterp\fR should use this pointer +as an opaque token, suitable for nothing other than passing back to +other routines in the Tcl interface. Accessing fields directly through +the pointer as described below is no longer supported. The supported +public routines \fBTcl_SetResult\fR, \fBTcl_GetResult\fR, +\fBTcl_SetErrorLine\fR, \fBTcl_GetErrorLine\fR must be used instead. .PP -\fBNote that access to all three fields, \fIresult\fB, \fIfreeProc\fB and -\fIerrorLine\fB is deprecated.\fR Use \fBTcl_SetResult\fR, -\fBTcl_GetResult\fR, and \fBTcl_GetReturnOptions\fR instead. +For legacy programs and extensions no longer being maintained, compiles +against the Tcl 8.6 header files are only possible with the compiler +directives +.CS +#define USE_INTERP_RESULT +.CE +and/or +.CS +#define USE_INTERP_ERRORLINE +.CE +depending on which fields of the \fBTcl_Interp\fR struct are accessed. +These directives may be embedded in code or supplied via compiler options. .PP The \fIresult\fR and \fIfreeProc\fR fields are used to return results or error messages from commands. |
