summaryrefslogtreecommitdiffstats
path: root/doc/StringObj.3
diff options
context:
space:
mode:
authorjan.nijtmans <nijtmans@users.sourceforge.net>2023-04-13 14:02:23 (GMT)
committerjan.nijtmans <nijtmans@users.sourceforge.net>2023-04-13 14:02:23 (GMT)
commit4307d0a739ddfd9545e59a0ccf16067fc2dab2a2 (patch)
treef399cf6578abde4532ed6b0f40ae2aa562eff10d /doc/StringObj.3
parent9c0541d0e4b22e9f9e12d754ba7c9bb1c430a0a8 (diff)
downloadtcl-4307d0a739ddfd9545e59a0ccf16067fc2dab2a2.zip
tcl-4307d0a739ddfd9545e59a0ccf16067fc2dab2a2.tar.gz
tcl-4307d0a739ddfd9545e59a0ccf16067fc2dab2a2.tar.bz2
Follow-up to previous commit: Let's not break TIP #627 either. Also adapt documentation (will be needed to be done anyway)
Diffstat (limited to 'doc/StringObj.3')
-rw-r--r--doc/StringObj.320
1 files changed, 10 insertions, 10 deletions
diff --git a/doc/StringObj.3 b/doc/StringObj.3
index 2d41018..e6144aa 100644
--- a/doc/StringObj.3
+++ b/doc/StringObj.3
@@ -40,7 +40,7 @@ Tcl_UniChar *
int
\fBTcl_GetUniChar\fR(\fIobjPtr, index\fR)
.sp
-size_t
+Tcl_Size
\fBTcl_GetCharLength\fR(\fIobjPtr\fR)
.sp
Tcl_Obj *
@@ -91,7 +91,7 @@ unless \fInumChars\fR is \fBTCL_INDEX_NONE\fR. (Applications needing null bytes
should represent them as the two-byte sequence \fI\e300\e200\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
+.AP Tcl_Size length in
The number of bytes to copy from \fIbytes\fR when
initializing, setting, or appending to a string value.
If \fBTCL_INDEX_NONE\fR, all bytes up to the first null are used.
@@ -100,17 +100,17 @@ Points to the first byte of an array of Unicode characters
used to set or append to a string value.
This byte array may contain embedded null characters
unless \fInumChars\fR is \fBTCL_INDEX_NONE\fR.
-.AP size_t numChars in
+.AP Tcl_Size numChars in
The number of Unicode characters to copy from \fIunicode\fR when
initializing, setting, or appending to a string value.
If \fBTCL_INDEX_NONE\fR, all characters up to the first null character are used.
-.AP size_t index in
+.AP Tcl_Size index in
The index of the Unicode character to return.
-.AP size_t first in
+.AP Tcl_Size first in
The index of the first Unicode character in the Unicode range to be
returned as a new value. If \fBTCL_INDEX_NONE\fR, behave the same as if the
value was 0.
-.AP size_t last in
+.AP Tcl_Size last in
The index of the last Unicode character in the Unicode range to be
returned as a new value. If \fBTCL_INDEX_NONE\fR, take all characters up to
the last one available.
@@ -118,7 +118,7 @@ the last one available.
Points to a value to manipulate.
.AP Tcl_Obj *appendObjPtr in
The value to append to \fIobjPtr\fR in \fBTcl_AppendObjToObj\fR.
-.AP "size_t \&| int" *lengthPtr out
+.AP "ptrdiff_t \&| int" *lengthPtr out
The location where \fBTcl_GetStringFromObj\fR will store the length
of a value's string representation. May be (int *)NULL when not used.
.AP "const char" *string in
@@ -126,7 +126,7 @@ Null-terminated string value to append to \fIobjPtr\fR.
.AP va_list argList in
An argument list which must have been initialized using
\fBva_start\fR, and cleared using \fBva_end\fR.
-.AP size_t limit in
+.AP Tcl_Size limit in
Maximum number of bytes to be appended.
.AP "const char" *ellipsis in
Suffix to append when the limit leads to string truncation.
@@ -135,11 +135,11 @@ If NULL is passed then the suffix
is used.
.AP "const char" *format in
Format control string including % conversion specifiers.
-.AP size_t objc in
+.AP Tcl_Size objc in
The number of elements to format or concatenate.
.AP Tcl_Obj *objv[] in
The array of values to format or concatenate.
-.AP size_t newLength in
+.AP Tcl_Size newLength in
New length for the string value of \fIobjPtr\fR, not including the
final null character.
.BE