[Python-checkins] cpython (2.7): Closing #17378: ctypes documentation fix.

Fri Mar 8 14:35:51 CET 2013

http://hg.python.org/cpython/rev/2dd77a12e7bf
changeset: 82547:2dd77a12e7bf
branch: 2.7
parent: 82516:cfc777407b03
user: Eli Bendersky <eliben at gmail.com>
date: Fri Mar 08 05:34:58 2013 -0800
summary:
 Closing #17378: ctypes documentation fix.
Document that ctypes automatically applies byref() when argtypes declares
POINTER.
files:
 Doc/library/ctypes.rst | 5 +++++
 1 files changed, 5 insertions(+), 0 deletions(-)

diff --git a/Doc/library/ctypes.rst b/Doc/library/ctypes.rst
--- a/Doc/library/ctypes.rst
+++ b/Doc/library/ctypes.rst
@@ -816,6 +816,11 @@
 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
-- 
Repository URL: http://hg.python.org/cpython
