diff options
| author | dkf <donal.k.fellows@manchester.ac.uk> | 2021-04-24 11:24:23 (GMT) |
|---|---|---|
| committer | dkf <donal.k.fellows@manchester.ac.uk> | 2021-04-24 11:24:23 (GMT) |
| commit | bd778f8dd4af97b8a349a22cfc23e3a047618c8d (patch) | |
| tree | 4040fcdad97ee7b84a598918a4dc9d5100ec4f35 /doc/DoubleObj.3 | |
| parent | 103d88f85a9ade51cda8d153915a204bede470a3 (diff) | |
| download | tcl-bd778f8dd4af97b8a349a22cfc23e3a047618c8d.zip tcl-bd778f8dd4af97b8a349a22cfc23e3a047618c8d.tar.gz tcl-bd778f8dd4af97b8a349a22cfc23e3a047618c8d.tar.bz2 | |
Documenting our reference count management
Diffstat (limited to 'doc/DoubleObj.3')
| -rw-r--r-- | doc/DoubleObj.3 | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/DoubleObj.3 b/doc/DoubleObj.3 index 85e4de5..c70f5d1 100644 --- a/doc/DoubleObj.3 +++ b/doc/DoubleObj.3 @@ -58,6 +58,18 @@ and if \fIinterp\fR is non-NULL, an error message is left in \fIinterp\fR. The \fBTcl_ObjType\fR of \fIobjPtr\fR may be changed to make subsequent calls to \fBTcl_GetDoubleFromObj\fR more efficient. '\" TODO: add discussion of treatment of NaN value +.SH "REFERENCE COUNT MANAGEMENT" +.PP +\fBTcl_NewDoubleObj\fR always returns a zero-reference object, much +like \fBTcl_NewObj\fR. +.PP +\fBTcl_SetDoubleObj\fR does not modify the reference count of its +\fIobjPtr\fR argument, but does require that the object be unshared. +.PP +\fBTcl_GetDoubleFromObj\fR does not modify the reference count of its +\fIobjPtr\fR argument; it only reads. Note however that this function +may set the interpreter result; if that is the only place that +is holding a reference to the object, it will be deleted. .SH "SEE ALSO" Tcl_NewObj, Tcl_DecrRefCount, Tcl_IncrRefCount, Tcl_GetObjResult .SH KEYWORDS |