mirror of https://github.com/python/cpython
Document PyOS_strtoul and PyOS_strtol (GH-114048)
This commit is contained in:
parent
d91ddff5de
commit
3f62bf32ca
|
@ -48,6 +48,42 @@ The return value (*rv*) for these functions should be interpreted as follows:
|
|||
|
||||
The following functions provide locale-independent string to number conversions.
|
||||
|
||||
.. c:function:: unsigned long PyOS_strtoul(const char *str, char **ptr, int base)
|
||||
|
||||
Convert the initial part of the string in ``str`` to an :c:expr:`unsigned
|
||||
long` value according to the given ``base``, which must be between ``2`` and
|
||||
``36`` inclusive, or be the special value ``0``.
|
||||
|
||||
Leading white space and case of characters are ignored. If ``base`` is zero
|
||||
it looks for a leading ``0b``, ``0o`` or ``0x`` to tell which base. If
|
||||
these are absent it defaults to ``10``. Base must be 0 or between 2 and 36
|
||||
(inclusive). If ``ptr`` is non-``NULL`` it will contain a pointer to the
|
||||
end of the scan.
|
||||
|
||||
If the converted value falls out of range of corresponding return type,
|
||||
range error occurs (:c:data:`errno` is set to :c:macro:`!ERANGE`) and
|
||||
:c:macro:`!ULONG_MAX` is returned. If no conversion can be performed, ``0``
|
||||
is returned.
|
||||
|
||||
See also the Unix man page :manpage:`strtoul(3)`.
|
||||
|
||||
.. versionadded:: 3.2
|
||||
|
||||
|
||||
.. c:function:: long PyOS_strtol(const char *str, char **ptr, int base)
|
||||
|
||||
Convert the initial part of the string in ``str`` to an :c:expr:`long` value
|
||||
according to the given ``base``, which must be between ``2`` and ``36``
|
||||
inclusive, or be the special value ``0``.
|
||||
|
||||
Same as :c:func:`PyOS_strtoul`, but return a :c:expr:`long` value instead
|
||||
and :c:macro:`LONG_MAX` on overflows.
|
||||
|
||||
See also the Unix man page :manpage:`strtol(3)`.
|
||||
|
||||
.. versionadded:: 3.2
|
||||
|
||||
|
||||
.. c:function:: double PyOS_string_to_double(const char *s, char **endptr, PyObject *overflow_exception)
|
||||
|
||||
Convert a string ``s`` to a :c:expr:`double`, raising a Python
|
||||
|
|
Loading…
Reference in New Issue