summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorgriffin <briang42@easystreet.net>2022-10-25 02:30:28 (GMT)
committergriffin <briang42@easystreet.net>2022-10-25 02:30:28 (GMT)
commit119e80fb283c3918232f8d9802d6908783d5f401 (patch)
tree8feeb754d85217a0afdb9dd5e63797f4a4e71358 /doc
parent6d3452eeac482d86c96b2bb357130a6f5ac9eb09 (diff)
parent1dfa3c7740734521f9a728b762a54e99555b9219 (diff)
downloadtcl-119e80fb283c3918232f8d9802d6908783d5f401.zip
tcl-119e80fb283c3918232f8d9802d6908783d5f401.tar.gz
tcl-119e80fb283c3918232f8d9802d6908783d5f401.tar.bz2
Sync with core-8-branch
Diffstat (limited to 'doc')
-rw-r--r--doc/BoolObj.312
-rw-r--r--doc/Encoding.36
2 files changed, 12 insertions, 6 deletions
diff --git a/doc/BoolObj.3 b/doc/BoolObj.3
index 47a2189..71580af 100644
--- a/doc/BoolObj.3
+++ b/doc/BoolObj.3
@@ -20,7 +20,7 @@ Tcl_Obj *
\fBTcl_SetBooleanObj\fR(\fIobjPtr, intValue\fR)
.sp
int
-\fBTcl_GetBooleanFromObj\fR(\fIinterp, objPtr, intPtr\fR)
+\fBTcl_GetBooleanFromObj\fR(\fIinterp, objPtr, boolPtr\fR)
.sp
int
\fBTcl_GetBoolFromObj\fR(\fIinterp, objPtr, flags. charPtr\fR)
@@ -35,7 +35,7 @@ retrieve a boolean value.
If a boolean value cannot be retrieved,
an error message is left in the interpreter's result value
unless \fIinterp\fR is NULL.
-.AP int *intPtr out
+.AP "bool \&| int" *boolPtr out
Points to place where \fBTcl_GetBooleanFromObj\fR
stores the boolean value (0 or 1) obtained from \fIobjPtr\fR.
.AP char *charPtr out
@@ -71,13 +71,13 @@ any former value stored in \fI*objPtr\fR.
from the value stored in \fI*objPtr\fR.
If \fIobjPtr\fR holds a string value recognized by \fBTcl_GetBoolean\fR,
then the recognized boolean value is written at the address given
-by \fIintPtr\fR.
+by \fIboolPtr\fR.
If \fIobjPtr\fR holds any value recognized as
a number by Tcl, then if that value is zero a 0 is written at
-the address given by \fIintPtr\fR and if that
-value is non-zero a 1 is written at the address given by \fIintPtr\fR.
+the address given by \fIboolPtr\fR and if that
+value is non-zero a 1 is written at the address given by \fIboolPtr\fR.
In all cases where a value is written at the address given
-by \fIintPtr\fR, \fBTcl_GetBooleanFromObj\fR returns \fBTCL_OK\fR.
+by \fIboolPtr\fR, \fBTcl_GetBooleanFromObj\fR returns \fBTCL_OK\fR.
If the value of \fIobjPtr\fR does not meet any of the conditions
above, then \fBTCL_ERROR\fR is returned and an error message is
left in the interpreter's result unless \fIinterp\fR is NULL.
diff --git a/doc/Encoding.3 b/doc/Encoding.3
index 553cc21..43bb2b8 100644
--- a/doc/Encoding.3
+++ b/doc/Encoding.3
@@ -52,6 +52,9 @@ const char *
\fBTcl_GetEncodingName\fR(\fIencoding\fR)
.sp
int
+\fBTcl_GetEncodingNulLength\fR(\fIencoding\fR)
+.sp
+int
\fBTcl_SetSystemEncoding\fR(\fIinterp, name\fR)
.sp
const char *
@@ -294,6 +297,9 @@ was used to create the encoding. The string returned by
\fBTcl_GetEncodingName\fR is only guaranteed to persist until the
\fIencoding\fR is deleted. The caller must not modify this string.
.PP
+\fBTcl_GetEncodingNulLength\fR returns the length of the terminating
+nul byte sequence for strings in the specified encoding.
+.PP
\fBTcl_SetSystemEncoding\fR sets the default encoding that should be used
whenever the user passes a NULL value for the \fIencoding\fR argument to
any of the other encoding functions. If \fIname\fR is NULL, the system