summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authoroehhar <harald.oehlmann@elmicron.de>2024-01-22 14:26:21 (GMT)
committeroehhar <harald.oehlmann@elmicron.de>2024-01-22 14:26:21 (GMT)
commita7841c171a88e7a2c8093141bff39d0232748f9c (patch)
treeb0fa8853bc2fa95db20c0bddb0e8279034d0468d
parentf6c924bc7323104fcefc728b1f6407e70cf585ae (diff)
downloadtcl-a7841c171a88e7a2c8093141bff39d0232748f9c.zip
tcl-a7841c171a88e7a2c8093141bff39d0232748f9c.tar.gz
tcl-a7841c171a88e7a2c8093141bff39d0232748f9c.tar.bz2
Doc of Tcl_AppendToObj: Document NULL data argument behaviour and buffer growth optimization.
-rw-r--r--doc/StringObj.36
1 files changed, 5 insertions, 1 deletions
diff --git a/doc/StringObj.3 b/doc/StringObj.3
index e569e62..0568d5a 100644
--- a/doc/StringObj.3
+++ b/doc/StringObj.3
@@ -221,12 +221,16 @@ to bytes) in the string value.
\fBTcl_AppendToObj\fR appends the data given by \fIbytes\fR and
\fIlength\fR to the string representation of the value specified by
\fIobjPtr\fR. If the value has an invalid string representation,
-then an attempt is made to convert \fIbytes\fR is to the Unicode
+then an attempt is made to convert \fIbytes\fR to the Unicode
format. If the conversion is successful, then the converted form of
\fIbytes\fR is appended to the value's Unicode representation.
Otherwise, the value's Unicode representation is invalidated and
converted to the UTF format, and \fIbytes\fR is appended to the
value's new string representation.
+\fIlength\fR bytes are allocated and not filled, if \fIbytes\fR is a
+null pointer.
+Eventually buffer growth is optimized by large allocations to optimize
+multiple calls.
.PP
\fBTcl_AppendUnicodeToObj\fR appends the Unicode string given by
\fIunicode\fR and \fInumChars\fR to the value specified by