summaryrefslogtreecommitdiffstats
path: root/doc/ListObj.3
diff options
context:
space:
mode:
authorhobbs <hobbs>2000-01-26 03:37:30 (GMT)
committerhobbs <hobbs>2000-01-26 03:37:30 (GMT)
commit04bd0d9f87302a0c6dfcf3641cee54bc29c3f223 (patch)
treea55cbc54826268b00ba33e4185f293956c234123 /doc/ListObj.3
parent985b9d320f2f4ba7c7b7914af60f5ef0be724288 (diff)
downloadtcl-04bd0d9f87302a0c6dfcf3641cee54bc29c3f223.zip
tcl-04bd0d9f87302a0c6dfcf3641cee54bc29c3f223.tar.gz
tcl-04bd0d9f87302a0c6dfcf3641cee54bc29c3f223.tar.bz2
* doc/ListObj.3: clarified Tcl_ListObjGetElements docs [Bug: 4080]
* doc/glob.n: clarified Mac path separator determination docs.
Diffstat (limited to 'doc/ListObj.3')
-rw-r--r--doc/ListObj.322
1 files changed, 11 insertions, 11 deletions
diff --git a/doc/ListObj.3 b/doc/ListObj.3
index 5a88c3d..9aaf858 100644
--- a/doc/ListObj.3
+++ b/doc/ListObj.3
@@ -4,7 +4,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: ListObj.3,v 1.3 1999/08/21 19:40:47 hobbs Exp $
+'\" RCS: @(#) $Id: ListObj.3,v 1.4 2000/01/26 03:37:30 hobbs Exp $
'\"
.so man.macros
.TH Tcl_ListObj 3 8.0 Tcl "Tcl Library Procedures"
@@ -149,16 +149,16 @@ of the elements in \fIobjc\fR since the list object now refers to them.
The new list object returned by \fBTcl_NewListObj\fR
has reference count zero.
.PP
-\fBTcl_ListObjGetElements\fR returns a count and
-a pointer to an array of the elements in a list object.
-It returns the count by storing it in the address \fIobjcPtr\fR.
-Similarly, it returns the array pointer by storing it
-in the address \fIobjvPtr\fR.
-If \fIlistPtr\fR is not already a list object,
-\fBTcl_ListObjGetElements\fR will attempt to convert it to one;
-if the conversion fails, it returns \fBTCL_ERROR\fR
-and leaves an error message in the interpreter's result object
-if \fIinterp\fR is not NULL.
+\fBTcl_ListObjGetElements\fR returns a count and a pointer to an array of
+the elements in a list object. It returns the count by storing it in the
+address \fIobjcPtr\fR. Similarly, it returns the array pointer by storing
+it in the address \fIobjvPtr\fR.
+The memory pointed to is managed by Tcl and should not be freed by the
+caller.
+If \fIlistPtr\fR is not already a list object, \fBTcl_ListObjGetElements\fR
+will attempt to convert it to one; if the conversion fails, it returns
+\fBTCL_ERROR\fR and leaves an error message in the interpreter's result
+object if \fIinterp\fR is not NULL.
Otherwise it returns \fBTCL_OK\fR after storing the count and array pointer.
.PP
\fBTcl_ListObjLength\fR returns the number of elements in the list object