summaryrefslogtreecommitdiffstats
path: root/doc/SetResult.3
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2004-10-05 23:21:26 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2004-10-05 23:21:26 (GMT)
commit120ce535474dc17d51d505e3aa8d4202dde2c81b (patch)
tree82b5c554b69b6016a3df4148202862a273fdfe8d /doc/SetResult.3
parentfba428714c97529bd8a332d353fb90dffebbd5eb (diff)
downloadtcl-120ce535474dc17d51d505e3aa8d4202dde2c81b.zip
tcl-120ce535474dc17d51d505e3aa8d4202dde2c81b.tar.gz
tcl-120ce535474dc17d51d505e3aa8d4202dde2c81b.tar.bz2
Make Tcl_AppendResult() non-deprecated again. [Patch 1041072]
Also change string to stringPtr to avoid potential future C++ problems.
Diffstat (limited to 'doc/SetResult.3')
-rw-r--r--doc/SetResult.323
1 files changed, 12 insertions, 11 deletions
diff --git a/doc/SetResult.3 b/doc/SetResult.3
index db1a5dc..cf7f623 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.8 2004/09/06 09:44:57 dkf Exp $
+'\" RCS: @(#) $Id: SetResult.3,v 1.9 2004/10/05 23:21:27 dkf Exp $
'\"
.so man.macros
.TH Tcl_SetResult 3 8.0 Tcl "Tcl Library Procedures"
@@ -116,14 +116,6 @@ and the result is left as a empty string.
\fBTcl_ResetResult\fR also clears the error state managed by
\fBTcl_AddErrorInfo\fR, \fBTcl_AddObjErrorInfo\fR,
and \fBTcl_SetErrorCode\fR.
-
-.SH "OLD STRING PROCEDURES"
-.PP
-Use of the following procedures is deprecated
-since they manipulate the Tcl result as a string.
-Procedures such as \fBTcl_SetObjResult\fR
-that manipulate the result as an object
-can be significantly more efficient.
.PP
\fBTcl_AppendResult\fR makes it easy to build up Tcl results in pieces.
It takes each of its \fIstring\fR arguments and appends them in order
@@ -137,13 +129,22 @@ of the result are produced.
\fBTcl_AppendResult\fR takes care of all the
storage management issues associated with managing \fIinterp\fR's
result, such as allocating a larger result area if necessary.
-It also converts the current interpreter result from an object
-to a string, if necessary, before appending the argument strings.
+It also manages conversion to and from the \fIresult\fR field of the
+\fIinterp\fR so as to handle backward-compatability with old-style
+extensions.
Any number of \fIstring\fR arguments may be passed in a single
call; the last argument in the list must be a NULL pointer.
.PP
\fBTcl_AppendResultVA\fR is the same as \fBTcl_AppendResult\fR except that
instead of taking a variable number of arguments it takes an argument list.
+
+.SH "OLD STRING PROCEDURES"
+.PP
+Use of the following procedures (is deprecated
+since they manipulate the Tcl result as a string.
+Procedures such as \fBTcl_SetObjResult\fR
+that manipulate the result as an object
+can be significantly more efficient.
.PP
\fBTcl_AppendElement\fR is similar to \fBTcl_AppendResult\fR in
that it allows results to be built up in pieces.