diff options
author | dkf <donal.k.fellows@manchester.ac.uk> | 2005-04-06 20:55:16 (GMT) |
---|---|---|
committer | dkf <donal.k.fellows@manchester.ac.uk> | 2005-04-06 20:55:16 (GMT) |
commit | 596f07e4bfed21c35b29972c3be0428e9cd51b5c (patch) | |
tree | 5d41883299c2e8bedcd2b437b39c4cbfab40c071 /doc/TraceVar.3 | |
parent | 854b41f3a7f5c48e906218248a4d28354d4c02e3 (diff) | |
download | tcl-596f07e4bfed21c35b29972c3be0428e9cd51b5c.zip tcl-596f07e4bfed21c35b29972c3be0428e9cd51b5c.tar.gz tcl-596f07e4bfed21c35b29972c3be0428e9cd51b5c.tar.bz2 |
Purge old and inaccurate .VS/.VE macros.
Diffstat (limited to 'doc/TraceVar.3')
-rw-r--r-- | doc/TraceVar.3 | 10 |
1 files changed, 1 insertions, 9 deletions
diff --git a/doc/TraceVar.3 b/doc/TraceVar.3 index dfd488d..19fad3b 100644 --- a/doc/TraceVar.3 +++ b/doc/TraceVar.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: TraceVar.3,v 1.13 2004/10/07 16:05:15 dkf Exp $ +'\" RCS: @(#) $Id: TraceVar.3,v 1.14 2005/04/06 20:55:22 dkf Exp $ '\" .so man.macros .TH Tcl_TraceVar 3 7.4 Tcl "Tcl Library Procedures" @@ -108,21 +108,17 @@ array names or array get is called. Note that this is called before an array set, but that will trigger write traces. .TP \fBTCL_TRACE_RESULT_DYNAMIC\fR -.VS 8.4 The result of invoking the \fIproc\fR is a dynamically allocated string that will be released by the Tcl library via a call to \fBckfree\fR. Must not be specified at the same time as \fBTCL_TRACE_RESULT_OBJECT\fR. -.VE 8.4 .TP \fBTCL_TRACE_RESULT_OBJECT\fR -.VS 8.4 The result of invoking the \fIproc\fR is a Tcl_Obj* (cast to a char*) with a reference count of at least one. The ownership of that reference will be transferred to the Tcl core for release (when the core has finished with it) via a call to \fBTcl_DecrRefCount\fR. Must not be specified at the same time as \fBTCL_TRACE_RESULT_DYNAMIC\fR. -.VE 8.4 .PP Whenever one of the specified operations occurs on the variable, \fIproc\fR will be invoked. @@ -209,7 +205,6 @@ The procedures \fBTcl_TraceVar2\fR, \fBTcl_UntraceVar2\fR, and except that the name of the variable consists of two parts. \fIName1\fR gives the name of a scalar variable or array, and \fIname2\fR gives the name of an element within an array. -.VS 8.1 When \fIname2\fR is NULL, \fIname1\fR may contain both an array and an element name: if the name contains an open parenthesis and ends with a @@ -219,7 +214,6 @@ the characters before the first open parenthesis are treated as the name of an array variable. If \fIname2\fR is NULL and \fIname1\fR does not refer to an array element -.VE it means that either the variable is a scalar or the trace is to be set on the entire array rather than an individual element (see WHOLE-ARRAY TRACES below for @@ -325,13 +319,11 @@ If \fIproc\fR returns a non-NULL value it signifies that an error occurred. The return value must be a pointer to a static character string containing an error message, -.VS 8.4 unless (\fIexactly\fR one of) the \fBTCL_TRACE_RESULT_DYNAMIC\fR and \fBTCL_TRACE_RESULT_OBJECT\fR flags is set, which specify that the result is either a dynamic string (to be released with \fBckfree\fR) or a Tcl_Obj* (cast to char* and to be released with \fBTcl_DecrRefCount\fR) containing the error message. -.VE 8.4 If a trace procedure returns an error, no further traces are invoked for the access and the traced access aborts with the given message. |