diff options
author | dkf <donal.k.fellows@manchester.ac.uk> | 2021-04-26 07:58:16 (GMT) |
---|---|---|
committer | dkf <donal.k.fellows@manchester.ac.uk> | 2021-04-26 07:58:16 (GMT) |
commit | 8d556345fd97eb9d60d2e7e1e372e1cc52939ff5 (patch) | |
tree | 6a816b87f19ec34be25a0f50066990db21455624 /doc/AddErrInfo.3 | |
parent | aa1949c4f3d10fedc5209ff5c34a9f6d2442293e (diff) | |
parent | 42a77f7b4b1e4f3699d71cd2cf9fe6de7e9e4d71 (diff) | |
download | tcl-8d556345fd97eb9d60d2e7e1e372e1cc52939ff5.zip tcl-8d556345fd97eb9d60d2e7e1e372e1cc52939ff5.tar.gz tcl-8d556345fd97eb9d60d2e7e1e372e1cc52939ff5.tar.bz2 |
merge core-8-branch
Diffstat (limited to 'doc/AddErrInfo.3')
-rw-r--r-- | doc/AddErrInfo.3 | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/AddErrInfo.3 b/doc/AddErrInfo.3 index e250127..5462d02 100644 --- a/doc/AddErrInfo.3 +++ b/doc/AddErrInfo.3 @@ -300,6 +300,22 @@ The global variables \fBerrorInfo\fR and \fBerrorCode\fR are not modified by \fBTcl_ResetResult\fR so they continue to hold a record of information about the most recent error seen in an interpreter. +.SH "REFERENCE COUNT MANAGEMENT" +.PP +The result of \fBTcl_GetReturnOptions\fR will have at least one +reference to it from the Tcl interpreter. If not using it immediately, +you should use \fBTcl_IncrRefCount\fR to add your own reference. +.PP +The \fIoptions\fR argument to \fBTcl_SetReturnOptions\fR will have a +reference added by the Tcl interpreter; it may safely be called with a +zero-reference value. +.PP +\fBTcl_AppendObjToErrorInfo\fR only reads its \fIobjPtr\fR argument; +it does not modify its reference count at all. +.PP +The \fIerrorObjPtr\fR argument to \fBTcl_SetObjErrorCode\fR will have a +reference added by the Tcl interpreter; it may safely be called with a +zero-reference value. .SH "SEE ALSO" Tcl_DecrRefCount(3), Tcl_IncrRefCount(3), Tcl_Interp(3), Tcl_ResetResult(3), Tcl_SetErrno(3), errorCode(n), errorInfo(n) |