From: Eli Bendersky <eliben@gmail.com>
Date: Fri, 8 Mar 2013 13:31:54 +0000 (-0800)
Subject: Issue #17378: ctypes documentation fix.
X-Git-Tag: v3.2.4rc1~50
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=f81de8df0aca07531087b56227b730889114c524;p=thirdparty%2FPython%2Fcpython.git

Issue #17378: ctypes documentation fix.

Document that ctypes automatically applies byref() when argtypes declares
POINTER.
---

diff --git a/Doc/library/ctypes.rst b/Doc/library/ctypes.rst
index 033c488f21c0..486c96355738 100644
--- a/Doc/library/ctypes.rst
+++ b/Doc/library/ctypes.rst
@@ -817,6 +817,11 @@ pointer types.  So, for ``POINTER(c_int)``, ctypes accepts an array of c_int::
    3
    >>>
 
+In addition, if a function argument is explicitly declared to be a pointer type
+(such as ``POINTER(c_int)``) in :attr:`argtypes`, an object of the pointed
+type (``c_int`` in this case) can be passed to the function.  ctypes will apply
+the required :func:`byref` conversion in this case automatically.
+
 To set a POINTER type field to ``NULL``, you can assign ``None``::
 
    >>> bar.values = None