diff options
author | hobbs <hobbs@noemail.net> | 2000-01-26 03:37:29 (GMT) |
---|---|---|
committer | hobbs <hobbs@noemail.net> | 2000-01-26 03:37:29 (GMT) |
commit | e6174887e9ef31ff548ca947baf25bbd6faf99bc (patch) | |
tree | a55cbc54826268b00ba33e4185f293956c234123 /doc/ListObj.3 | |
parent | 762eca921531edcde463a781f47caafa23313ee4 (diff) | |
download | tcl-e6174887e9ef31ff548ca947baf25bbd6faf99bc.zip tcl-e6174887e9ef31ff548ca947baf25bbd6faf99bc.tar.gz tcl-e6174887e9ef31ff548ca947baf25bbd6faf99bc.tar.bz2 |
* doc/ListObj.3: clarified Tcl_ListObjGetElements docs [Bug: 4080]
* doc/glob.n: clarified Mac path separator determination docs.
FossilOrigin-Name: 7544ca4f08131d2791ae23f55b774c60bfb81293
Diffstat (limited to 'doc/ListObj.3')
-rw-r--r-- | doc/ListObj.3 | 22 |
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 |