diff options
| author | dkf <donal.k.fellows@manchester.ac.uk> | 2021-04-25 12:01:10 (GMT) |
|---|---|---|
| committer | dkf <donal.k.fellows@manchester.ac.uk> | 2021-04-25 12:01:10 (GMT) |
| commit | 4aa680d80d061bebaf17ae938a541d6caff522cf (patch) | |
| tree | 1027e15529b68bd0db0c60592be46aa084f33a38 /doc/ParseArgs.3 | |
| parent | b63d1213ed575f5b179c1e9244ec808e2fe69b96 (diff) | |
| download | tcl-4aa680d80d061bebaf17ae938a541d6caff522cf.zip tcl-4aa680d80d061bebaf17ae938a541d6caff522cf.tar.gz tcl-4aa680d80d061bebaf17ae938a541d6caff522cf.tar.bz2 | |
Documenting our reference count management
Diffstat (limited to 'doc/ParseArgs.3')
| -rw-r--r-- | doc/ParseArgs.3 | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/ParseArgs.3 b/doc/ParseArgs.3 index def55de..5ca9fa5 100644 --- a/doc/ParseArgs.3 +++ b/doc/ParseArgs.3 @@ -189,6 +189,12 @@ will be stored at \fIdstPtr\fR; the string inside will have a lifetime linked to the lifetime of the string representation of the argument value that it came from, and so should be copied if it needs to be retained. The \fIsrcPtr\fR and \fIclientData\fR fields are ignored. +.SH "REFERENCE COUNT MANAGEMENT" +.PP +The values in the \fiobjv\fR argument to \fBTcl_ParseArgsObjv\fR will not have +their reference counts modified by this function. The interpreter result may +be modified on error; the values passed should not be the interpreter result +with no further reference added. .SH "SEE ALSO" Tcl_GetIndexFromObj(3), Tcl_Main(3), Tcl_CreateObjCommand(3) .SH KEYWORDS |