diff options
author | Benjamin Peterson <benjamin@python.org> | 2009-07-01 01:28:55 (GMT) |
---|---|---|
committer | Benjamin Peterson <benjamin@python.org> | 2009-07-01 01:28:55 (GMT) |
commit | f1664ae13a4c2505ed1fee2d1090ee701c07aa63 (patch) | |
tree | fcf1796ac15c61bfb86b5f6071d4a8ede0bfa1b5 /Doc/c-api | |
parent | 286a0d2ff7b04474dca7e30b3612ae699db5234a (diff) | |
download | cpython-f1664ae13a4c2505ed1fee2d1090ee701c07aa63.zip cpython-f1664ae13a4c2505ed1fee2d1090ee701c07aa63.tar.gz cpython-f1664ae13a4c2505ed1fee2d1090ee701c07aa63.tar.bz2 |
remove PyCObject
Diffstat (limited to 'Doc/c-api')
-rw-r--r-- | Doc/c-api/cobject.rst | 59 |
1 files changed, 0 insertions, 59 deletions
diff --git a/Doc/c-api/cobject.rst b/Doc/c-api/cobject.rst deleted file mode 100644 index ee65a98..0000000 --- a/Doc/c-api/cobject.rst +++ /dev/null @@ -1,59 +0,0 @@ -.. highlightlang:: c - -.. _cobjects: - -CObjects --------- - -.. index:: object: CObject - - -.. warning:: - - The CObject API is deprecated as of Python 3.1. Please switch to the new - :ref:`capsules` API. - -.. ctype:: PyCObject - - This subtype of :ctype:`PyObject` represents an opaque value, useful for C - extension modules who need to pass an opaque value (as a :ctype:`void\*` - pointer) through Python code to other C code. It is often used to make a C - function pointer defined in one module available to other modules, so the - regular import mechanism can be used to access C APIs defined in dynamically - loaded modules. - - -.. cfunction:: int PyCObject_Check(PyObject *p) - - Return true if its argument is a :ctype:`PyCObject`. - - -.. cfunction:: PyObject* PyCObject_FromVoidPtr(void* cobj, void (*destr)(void *)) - - Create a :ctype:`PyCObject` from the ``void *`` *cobj*. The *destr* function - will be called when the object is reclaimed, unless it is *NULL*. - - -.. cfunction:: PyObject* PyCObject_FromVoidPtrAndDesc(void* cobj, void* desc, void (*destr)(void *, void *)) - - Create a :ctype:`PyCObject` from the :ctype:`void \*` *cobj*. The *destr* - function will be called when the object is reclaimed. The *desc* argument can - be used to pass extra callback data for the destructor function. - - -.. cfunction:: void* PyCObject_AsVoidPtr(PyObject* self) - - Return the object :ctype:`void \*` that the :ctype:`PyCObject` *self* was - created with. - - -.. cfunction:: void* PyCObject_GetDesc(PyObject* self) - - Return the description :ctype:`void \*` that the :ctype:`PyCObject` *self* was - created with. - - -.. cfunction:: int PyCObject_SetVoidPtr(PyObject* self, void* cobj) - - Set the void pointer inside *self* to *cobj*. The :ctype:`PyCObject` must not - have an associated destructor. Return true on success, false on failure. |