diff options
| author | jan.nijtmans <nijtmans@users.sourceforge.net> | 2023-11-12 16:51:03 (GMT) |
|---|---|---|
| committer | jan.nijtmans <nijtmans@users.sourceforge.net> | 2023-11-12 16:51:03 (GMT) |
| commit | ec83a283603b2237b96bcc1a5027a5359e54e13b (patch) | |
| tree | d5e85e38010055de676fd07dda881c44b18ea925 /doc/ByteArrObj.3 | |
| parent | f47830f0bfb26ff837543decf98c0c2689b9605f (diff) | |
| parent | c8688135b89fe8d42059ab5e20cac7d95686a258 (diff) | |
| download | tcl-ec83a283603b2237b96bcc1a5027a5359e54e13b.zip tcl-ec83a283603b2237b96bcc1a5027a5359e54e13b.tar.gz tcl-ec83a283603b2237b96bcc1a5027a5359e54e13b.tar.bz2 | |
TIP #664: Enable compiler warnings for missing int → Tcl_Size conversions
Diffstat (limited to 'doc/ByteArrObj.3')
| -rw-r--r-- | doc/ByteArrObj.3 | 7 |
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 |