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/ParseArgs.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/ParseArgs.3')
| -rw-r--r-- | doc/ParseArgs.3 | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/doc/ParseArgs.3 b/doc/ParseArgs.3 index 7f81fb7..ab3b7d8 100644 --- a/doc/ParseArgs.3 +++ b/doc/ParseArgs.3 @@ -24,7 +24,11 @@ Pointer to array of option descriptors. .AP "Tcl_Size \&| int" *objcPtr in/out A pointer to variable holding number of arguments in \fIobjv\fR. Will be modified to hold number of arguments left in the unprocessed argument list -stored in \fIremObjv\fR. +stored in \fIremObjv\fR. 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 the number of elements is larger than INT_MAX +this function will return TCL_ERROR (which should trigger proper error-handling). +Apart from that, it will function as expected. .AP "Tcl_Obj *const" *objv in The array of arguments to be parsed. .AP Tcl_Obj ***remObjv out |