AuroraMiddleware/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

document that output parameter of ToLong/Double() shouldn't be used if the function returns false

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@50558 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin 2007-12-07 12:04:57 +00:00
parent 6fc93e9bdd
commit c6dcefd2b8
1 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/latex/wx/wxstring.tex
View File

@ -1204,8 +1204,9 @@ powerful means of converting wxString to C string.
\constfunc{bool}{ToDouble}{\param{double}{ *val}}
Attempts to convert the string to a floating point number. Returns \true on
success (the number is stored in the location pointed to by {\it val}) or \false
if the string does not represent such number.
success (the number is stored in the location pointed to by \arg{val}) or \false
if the string does not represent such number (the value of \arg{val} shouldn't
be used in this case).
\wxheading{See also}
@ -1219,8 +1220,9 @@ if the string does not represent such number.
Attempts to convert the string to a signed integer in base {\it base}. Returns
\true on success in which case the number is stored in the location
pointed to by {\it val} or \false if the string does not represent a
valid number in the given base.
pointed to by \arg{val} or \false if the string does not represent a
valid number in the given base (the value of \arg{val} shouldn't
be used in this case).
The value of {\it base} must be comprised between $2$ and $36$, inclusive, or
be a special value $0$ which means that the usual rules of {\tt C} numbers are
@ -1259,8 +1261,9 @@ with C99 support and Microsoft Visual C++ version 7 and higher do support this.
Attempts to convert the string to an unsigned integer in base {\it base}.
Returns \true on success in which case the number is stored in the
location pointed to by {\it val} or \false if the string does not
represent a valid number in the given base. Please notice that this function
location pointed to by \arg{val} or \false if the string does not
represent a valid number in the given base (the value of \arg{val} shouldn't
be used in this case). Please notice that this function
behaves in the same way as the standard \texttt{strtoul()} and so it simply
converts negative numbers to unsigned representation instead of rejecting them
(e.g. $-1$ is returned as \texttt{ULONG\_MAX}).