diff options
| author | dkf <donal.k.fellows@manchester.ac.uk> | 2021-04-24 12:51:07 (GMT) |
|---|---|---|
| committer | dkf <donal.k.fellows@manchester.ac.uk> | 2021-04-24 12:51:07 (GMT) |
| commit | ae32db3ffacfa9f981fd259a0feca4f3170eb8bb (patch) | |
| tree | 5d4f3005c395b137478a53a0c960bd3a33118b1a /doc/ExprLongObj.3 | |
| parent | bd778f8dd4af97b8a349a22cfc23e3a047618c8d (diff) | |
| download | tcl-ae32db3ffacfa9f981fd259a0feca4f3170eb8bb.zip tcl-ae32db3ffacfa9f981fd259a0feca4f3170eb8bb.tar.gz tcl-ae32db3ffacfa9f981fd259a0feca4f3170eb8bb.tar.bz2 | |
Documenting our reference count management
Diffstat (limited to 'doc/ExprLongObj.3')
| -rw-r--r-- | doc/ExprLongObj.3 | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/ExprLongObj.3 b/doc/ExprLongObj.3 index 837e0a8..59413e1 100644 --- a/doc/ExprLongObj.3 +++ b/doc/ExprLongObj.3 @@ -98,6 +98,15 @@ containing the expression's value at \fI*resultPtrPtr\fR. In this case, the caller is responsible for calling \fBTcl_DecrRefCount\fR to decrement the value's reference count when it is finished with the value. +.SH "REFERENCE COUNT MANAGEMENT" +.PP +\fBTcl_ExprLongObj\fR, \fBTcl_ExprDoubleObj\fR, +\fBTcl_ExprBooleanObj\fR, and \fBTcl_ExprObj\fR all increment and +decrement the reference count of their \fIobjPtr\fR arguments; you +must not pass them any value with a reference count of zero. They also +manipulate the interpreter result; you must not count on the +interpreter result to hold the reference count of any value over these +calls. .SH "SEE ALSO" Tcl_ExprLong, Tcl_ExprDouble, Tcl_ExprBoolean, Tcl_ExprString, Tcl_GetObjResult |