summaryrefslogtreecommitdiffstats
path: root/doc/ByteArrObj.3
diff options
context:
space:
mode:
authorjan.nijtmans <nijtmans@users.sourceforge.net>2023-11-12 16:51:03 (GMT)
committerjan.nijtmans <nijtmans@users.sourceforge.net>2023-11-12 16:51:03 (GMT)
commit65d7ec626d98c3b3143917119c49bd55c2c2bbe4 (patch)
treed5e85e38010055de676fd07dda881c44b18ea925 /doc/ByteArrObj.3
parent716a20f7e5a0600f4cd4a7faff07ae2fef468b0d (diff)
parentfb02c7f0083f3e1c4a07119b5003c6eaa4dd05f7 (diff)
downloadtcl-65d7ec626d98c3b3143917119c49bd55c2c2bbe4.zip
tcl-65d7ec626d98c3b3143917119c49bd55c2c2bbe4.tar.gz
tcl-65d7ec626d98c3b3143917119c49bd55c2c2bbe4.tar.bz2
TIP #664: Enable compiler warnings for missing int → Tcl_Size conversions
Diffstat (limited to 'doc/ByteArrObj.3')
-rw-r--r--doc/ByteArrObj.37
1 files changed, 5 insertions, 2 deletions
diff --git a/doc/ByteArrObj.3 b/doc/ByteArrObj.3
index 32e042f..70ebe04 100644
--- a/doc/ByteArrObj.3
+++ b/doc/ByteArrObj.3
@@ -45,9 +45,12 @@ to the value from which to extract an array of bytes.
Interpreter to use for error reporting.
.AP "Tcl_Size \&| int" *numBytesPtr out
Points to space where the number of bytes in the array may be written.
-Caller may pass NULL when it does not need this information.
+May be (Tcl_Size *)NULL when not used. If it points to a variable which
+type is not \fBTcl_Size\fR, a compiler warning will be generated, in
+order to indicate that when size of the byte array is larger than INT_MAX
+this function will return NULL (which should trigger proper error-handling).
+Apart from that, it will function as expected.
.BE
-
.SH DESCRIPTION
.PP
These routines are used to create, modify, store, transfer, and retrieve