]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/wxstring.tex
compilation fix after TRUE/FALSE change
[wxWidgets.git] / docs / latex / wx / wxstring.tex
index 7f68813c74578995b02fe19af14f5f00fb50f304..6cc43e1378b41240976d914c2c36ce4a0adcd3cc 100644 (file)
@@ -922,17 +922,20 @@ if the string does not represent such number.
 
 \membersection{wxString::ToLong}\label{wxstringtolong}
 
-\constfunc{bool}{ToLong}{\param{long}{ *val}, \param{int }{base = 0}}
+\constfunc{bool}{ToLong}{\param{long}{ *val}, \param{int }{base = $10$}}
 
 Attempts to convert the string to a signed integer in base {\it base}. Returns
 {\tt TRUE} on success in which case the number is stored in the location
 pointed to by {\it val} or {\tt FALSE} if the string does not represent a
 valid number in the given base.
 
-The default value of {\it base} $0$ is special and means that the usual rules
-of {\tt C} numbers are applied: if the number starts with {\tt 0x} it is
-considered to be in base $16$, if it starts with {\tt 0} - in base $8$ and in
-base $10$ otherwise.
+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
+applied: if the number starts with {\tt 0x} it is considered to be in base
+$16$, if it starts with {\tt 0} - in base $8$ and in base $10$ otherwise. Note
+that you may not want to specify the base $0$ if you are parsing the numbers
+which may have leading zeroes as they can yield unexpected (to the user not
+familiar with C) results.
 
 \wxheading{See also}
 
@@ -941,17 +944,15 @@ base $10$ otherwise.
 
 \membersection{wxString::ToULong}\label{wxstringtoulong}
 
-\constfunc{bool}{ToULong}{\param{unsigned long}{ *val}, \param{int }{base = 0}}
+\constfunc{bool}{ToULong}{\param{unsigned long}{ *val}, \param{int }{base = $10$}}
 
 Attempts to convert the string to a ansigned integer in base {\it base}.
 Returns {\tt TRUE} on success in which case the number is stored in the
 location pointed to by {\it val} or {\tt FALSE} if the string does not
 represent a valid number in the given base.
 
-The default value of {\it base} $0$ is special and means that the usual rules
-of {\tt C} numbers are applied: if the number starts with {\tt 0x} it is
-considered to be in base $16$, if it starts with {\tt 0} - in base $8$ and in
-base $10$ otherwise.
+See \helpref{wxString::ToLong}{wxstringtolong} for the more detailed
+description of the {\it base} parameter.
 
 \wxheading{See also}