diff options
| author | dkf <donal.k.fellows@manchester.ac.uk> | 2021-04-25 13:58:22 (GMT) |
|---|---|---|
| committer | dkf <donal.k.fellows@manchester.ac.uk> | 2021-04-25 13:58:22 (GMT) |
| commit | c1cc3a72382efe93780f665b571785402f056366 (patch) | |
| tree | 46de5bfce2a14823df9e480c636ee8eba27d7779 /doc/RecEvalObj.3 | |
| parent | 4aa680d80d061bebaf17ae938a541d6caff522cf (diff) | |
| download | tcl-c1cc3a72382efe93780f665b571785402f056366.zip tcl-c1cc3a72382efe93780f665b571785402f056366.tar.gz tcl-c1cc3a72382efe93780f665b571785402f056366.tar.bz2 | |
Documenting our reference count management
Diffstat (limited to 'doc/RecEvalObj.3')
| -rw-r--r-- | doc/RecEvalObj.3 | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/RecEvalObj.3 b/doc/RecEvalObj.3 index f9550a2..e68f4b5 100644 --- a/doc/RecEvalObj.3 +++ b/doc/RecEvalObj.3 @@ -44,6 +44,12 @@ allow the user to re-issue recently invoked commands. If the \fIflags\fR argument contains the \fBTCL_NO_EVAL\fR bit then the command is recorded without being evaluated. +.SH "REFERENCE COUNT MANAGEMENT" +.PP +The reference count of the \fIcmdPtr\fR argument to \fBTcl_RecordAndEvalObj\fR +must be at least 1. This function will modify the interpreter result; do not +use an existing result as \fIcmdPtr\fR directly without incrementing its +reference count. .SH "SEE ALSO" Tcl_EvalObjEx, Tcl_GetObjResult |