summaryrefslogtreecommitdiffstats
path: root/doc/StringObj.3
diff options
context:
space:
mode:
authorjan.nijtmans <nijtmans@users.sourceforge.net>2018-11-18 10:29:41 (GMT)
committerjan.nijtmans <nijtmans@users.sourceforge.net>2018-11-18 10:29:41 (GMT)
commitb2a63152cbf72e7a23e9870d94bbf551373ef84b (patch)
tree7edbe522c18e704c6481c96aaa17f1163c688ca7 /doc/StringObj.3
parentf1dbfbf21581370d5dad9cbeb4c8ac09f93fb30c (diff)
downloadtcl-b2a63152cbf72e7a23e9870d94bbf551373ef84b.zip
tcl-b2a63152cbf72e7a23e9870d94bbf551373ef84b.tar.gz
tcl-b2a63152cbf72e7a23e9870d94bbf551373ef84b.tar.bz2
Now that we have TCL_AUTO_LENGTH/TCL_IO_FAILURE macro's, use them to make code and documentation more readable.
Shifted to feature branch as a temporary measure since it doesn't build.
Diffstat (limited to 'doc/StringObj.3')
-rw-r--r--doc/StringObj.36
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/StringObj.3 b/doc/StringObj.3
index 93d8868..56ed654 100644
--- a/doc/StringObj.3
+++ b/doc/StringObj.3
@@ -87,14 +87,14 @@ Tcl_Obj *
Points to the first byte of an array of UTF-8-encoded bytes
used to set or append to a string value.
This byte array may contain embedded null characters
-unless \fInumChars\fR is (size_t)-1. (Applications needing null bytes
+unless \fInumChars\fR is TCL_AUTO_LENGTH. (Applications needing null bytes
should represent them as the two-byte sequence \fI\e700\e600\fR, use
\fBTcl_ExternalToUtf\fR to convert, or \fBTcl_NewByteArrayObj\fR if
the string is a collection of uninterpreted bytes.)
.AP size_t length in
The number of bytes to copy from \fIbytes\fR when
initializing, setting, or appending to a string value.
-If (size_t)-1, all bytes up to the first null are used.
+If TCL_AUTO_LENGTH, all bytes up to the first null are used.
.AP "const Tcl_UniChar" *unicode in
Points to the first byte of an array of Unicode characters
used to set or append to a string value.
@@ -103,7 +103,7 @@ unless \fInumChars\fR is negative.
.AP size_t numChars in
The number of Unicode characters to copy from \fIunicode\fR when
initializing, setting, or appending to a string value.
-If (size_t)-1, all characters up to the first null character are used.
+If TCL_AUTO_LENGTH, all characters up to the first null character are used.
.AP size_t index in
The index of the Unicode character to return.
.AP size_t first in