summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/AddErrInfo.32
-rw-r--r--doc/DString.32
-rw-r--r--doc/StringObj.36
-rw-r--r--doc/TclZlib.34
-rw-r--r--doc/Utf.34
5 files changed, 9 insertions, 9 deletions
diff --git a/doc/AddErrInfo.3 b/doc/AddErrInfo.3
index 10052cf..95451d3 100644
--- a/doc/AddErrInfo.3
+++ b/doc/AddErrInfo.3
@@ -61,7 +61,7 @@ in the form of a Tcl_Obj value.
.AP size_t length in
The number of bytes to copy from \fImessage\fR when
appending to the \fB\-errorinfo\fR return option.
-If (size_t)-1, all bytes up to the first null byte are used.
+If TCL_AUTO_LENGTH, all bytes up to the first null byte are used.
.AP Tcl_Obj *errorObjPtr in
The \fB\-errorcode\fR return option will be set to this value.
.AP char *element in
diff --git a/doc/DString.3 b/doc/DString.3
index 25c4c63..b4d0922 100644
--- a/doc/DString.3
+++ b/doc/DString.3
@@ -48,7 +48,7 @@ Pointer to characters to append to dynamic string.
.AP "const char" *element in
Pointer to characters to append as list element to dynamic string.
.AP size_t length in
-Number of bytes from \fIbytes\fR to add to dynamic string. If (size_t)-1,
+Number of bytes from \fIbytes\fR to add to dynamic string. If TCL_AUTO_LENGTH,
add all characters up to null terminating character.
.AP size_t newLength in
New length for dynamic string, not including null terminating
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
diff --git a/doc/TclZlib.3 b/doc/TclZlib.3
index 4bb0983..4093cfc 100644
--- a/doc/TclZlib.3
+++ b/doc/TclZlib.3
@@ -108,8 +108,8 @@ into a state where the decompressor can recover from on corruption, or
\fBTCL_ZLIB_FINALIZE\fR to ensure that the stream is finished and that any
trailer demanded by the format is written.
.AP size_t count in
-The maximum number of bytes to get from the stream, or (size_t)-1 to get all remaining
-bytes from the stream's buffers.
+The maximum number of bytes to get from the stream, or TCL_AUTO_LENGTH to get
+all remaining bytes from the stream's buffers.
.AP Tcl_Obj *compDict in
A byte array value that is the compression dictionary to use with the stream.
Note that this is \fInot a Tcl dictionary\fR, and it is recommended that this
diff --git a/doc/Utf.3 b/doc/Utf.3
index e546486..3bb285e 100644
--- a/doc/Utf.3
+++ b/doc/Utf.3
@@ -96,7 +96,7 @@ A null-terminated Unicode string.
A null-terminated Unicode string.
.AP size_t length in
The length of the UTF-8 string in bytes (not UTF-8 characters). If
-(size_t)-1, all bytes up to the first null byte are used.
+TCL_AUTO_LENGTH, all bytes up to the first null byte are used.
.AP size_t uniLength in
The length of the Unicode string in characters.
.AP "Tcl_DString" *dsPtr in/out
@@ -243,7 +243,7 @@ characters.
\fBTcl_UtfAtIndex\fR returns a pointer to the specified character (not
byte) \fIindex\fR in the UTF-8 string \fIsrc\fR. The source string must
contain at least \fIindex\fR characters. This is equivalent to calling
-\fBTcl_UtfNext\fR \fIindex\fR times. If \fIindex\fR is (size_t)-1,
+\fBTcl_UtfNext\fR \fIindex\fR times. If \fIindex\fR is TCL_AUTO_LENGTH,
the return pointer points to the first character in the source string.
.PP
\fBTcl_UtfBackslash\fR is a utility procedure used by several of the Tcl