From: Thomas Heller <theller@ctypes.org>
Date: Wed, 23 Apr 2003 19:51:05 +0000 (+0000)
Subject: Document the new functions PyInt_AsUnsignedLongMask(), PyInt_AsUnsignedLongLongMask(),
X-Git-Tag: v2.3c1~1057
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=34d7f0927beb9fe77b71ca53f251ece13c73245b;p=python

Document the new functions PyInt_AsUnsignedLongMask(), PyInt_AsUnsignedLongLongMask(),
PyLong_AsUnsignedLongMask(), PyLong_AsUnsignedLongLongMask().
---

diff --git a/Doc/api/concrete.tex b/Doc/api/concrete.tex
index 48c44b1777..cc3b2abf8c 100644
--- a/Doc/api/concrete.tex
+++ b/Doc/api/concrete.tex
@@ -168,6 +168,20 @@ There is no \cfunction{PyNone_Check()} function for the same reason.
   performed.
 \end{cfuncdesc}
 
+\begin{cfuncdesc}{unsigned long}{PyInt_AsUnsignedLongMask}{PyObject *io}
+  Will first attempt to cast the object to a \ctype{PyIntObject} or
+  \ctypes{PyLongObject}, if it is not already one, and then return its
+  value as unsigned long.  This function does not check for overflow.
+  \versionadded{2.3}
+\end{cfuncdesc}
+
+\begin{cfuncdesc}{unsigned long}{PyInt_AsUnsignedLongLongMask}{PyObject *io}
+  Will first attempt to cast the object to a \ctype{PyIntObject} or
+  \ctypes{PyLongObject}, if it is not already one, and then return its
+  value as unsigned long long, without checking for overflow.
+  \versionadded{2.3}
+\end{cfuncdesc}
+
 \begin{cfuncdesc}{long}{PyInt_GetMax}{}
   Returns the system's idea of the largest integer it can handle
   (\constant{LONG_MAX}\ttindex{LONG_MAX}, as defined in the system
@@ -293,6 +307,18 @@ There is no \cfunction{PyNone_Check()} function for the same reason.
   \versionadded{2.2}
 \end{cfuncdesc}
 
+\begin{cfuncdesc}{unsigned long}{PyLong_AsUnsignedLongMask}{PyObject *io}
+  Return a C \ctype{unsigned long} from a Python long integer, without
+  checking for overflow.
+  \versionadded{2.3}
+\end{cfuncdesc}
+
+\begin{cfuncdesc}{unsigned long}{PyLong_AsUnsignedLongLongMask}{PyObject *io}
+  Return a C \ctype{unsigned long long} from a Python long integer, without
+  checking for overflow.
+  \versionadded{2.3}
+\end{cfuncdesc}
+
 \begin{cfuncdesc}{double}{PyLong_AsDouble}{PyObject *pylong}
   Returns a C \ctype{double} representation of the contents of
   \var{pylong}.  If \var{pylong} cannot be approximately represented