<!DOCTYPE html PUBLIC
"-//W3C//DTD HTML 4.0 Transitional//EN">
<link rel=
"STYLESHEET" href=
"api.css" type='text/css'
/>
<link rel=
"SHORTCUT ICON" href=
"../icons/pyfav.png" type=
"image/png" />
<link rel='start' href='../index.html' title='Python Documentation Index'
/>
<link rel=
"first" href=
"api.html" title='Python/C API Reference Manual'
/>
<link rel='contents' href='contents.html'
title=
"Contents" />
<link rel='index' href='genindex.html' title='Index'
/>
<link rel='last' href='about.html' title='About this document...'
/>
<link rel='help' href='about.html' title='About this document...'
/>
<link rel=
"next" href=
"cell-objects.html" />
<link rel=
"prev" href=
"weakref-objects.html" />
<link rel=
"parent" href=
"otherObjects.html" />
<link rel=
"next" href=
"cell-objects.html" />
<meta name='aesop' content='information'
/>
<title>7.5.9 CObjects
</title>
<div id='top-navigation-panel' xml:id='top-navigation-panel'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<td class='online-navigation'
><a rel=
"prev" title=
"7.5.8 Weak Reference Objects"
href=
"weakref-objects.html"><img src='../icons/previous.png'
border='
0' height='
32' alt='Previous Page' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"parent" title=
"7.5 Other Objects"
href=
"otherObjects.html"><img src='../icons/up.png'
border='
0' height='
32' alt='Up One Level' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"next" title=
"7.5.10 Cell Objects"
href=
"cell-objects.html"><img src='../icons/next.png'
border='
0' height='
32' alt='Next Page' width='
32'
/></A></td>
<td align=
"center" width=
"100%">Python/C API Reference Manual
</td>
<td class='online-navigation'
><a rel=
"contents" title=
"Table of Contents"
href=
"contents.html"><img src='../icons/contents.png'
border='
0' height='
32' alt='Contents' width='
32'
/></A></td>
<td class='online-navigation'
><img src='../icons/blank.png'
border='
0' height='
32' alt='' width='
32'
/></td>
<td class='online-navigation'
><a rel=
"index" title=
"Index"
href=
"genindex.html"><img src='../icons/index.png'
border='
0' height='
32' alt='Index' width='
32'
/></A></td>
<div class='online-navigation'
>
<b class=
"navlabel">Previous:
</b>
<a class=
"sectref" rel=
"prev" href=
"weakref-objects.html">7.5.8 Weak Reference Objects
</A>
<b class=
"navlabel">Up:
</b>
<a class=
"sectref" rel=
"parent" href=
"otherObjects.html">7.5 Other Objects
</A>
<b class=
"navlabel">Next:
</b>
<a class=
"sectref" rel=
"next" href=
"cell-objects.html">7.5.10 Cell Objects
</A>
<!--End of Navigation Panel-->
<H2><A NAME=
"SECTION009590000000000000000"></A><A NAME=
"cObjects"></A>
<a id='l2h-
725' xml:id='l2h-
725'
></a>Refer to
<em>Extending and Embedding the Python Interpreter
</em>,
section
1.12, ``Providing a C API for an Extension Module,'' for more
information on using these objects.
<dl><dt><b><tt class=
"ctype"><a id='l2h-
726' xml:id='l2h-
726'
>PyCObject
</a></tt></b></dt>
This subtype of
<tt class=
"ctype">PyObject
</tt> represents an opaque value, useful
for C extension modules who need to pass an opaque value (as a
<tt class=
"ctype">void*
</tt> 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.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline"><td><nobr>int
<b><tt id='l2h-
727' xml:id='l2h-
727'
class=
"cfunction">PyCObject_Check
</tt></b>(
</nobr></td><td>PyObject *
<var>p
</var>)
</td></tr></table></dt>
Return true if its argument is a
<tt class=
"ctype">PyCObject
</tt>.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline"><td><nobr>PyObject*
<b><tt id='l2h-
728' xml:id='l2h-
728'
class=
"cfunction">PyCObject_FromVoidPtr
</tt></b>(
</nobr></td><td>void*
<var>cobj
</var>,
void (*destr)(void *))
</td></tr></table></dt>
<div class=
"refcount-info">
<span class=
"label">Return value:
</span>
<span class=
"value">New reference.
</span>
Create a
<tt class=
"ctype">PyCObject
</tt> from the
<code>void *
</code><var>cobj
</var>. The
<var>destr
</var> function will be called when the object is reclaimed,
unless it is
<tt class=
"constant">NULL
</tt>.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline"><td><nobr>PyObject*
<b><tt id='l2h-
729' xml:id='l2h-
729'
class=
"cfunction">PyCObject_FromVoidPtrAndDesc
</tt></b>(
</nobr></td><td>void*
<var>cobj
</var>,
void*
<var>desc
</var>, void (*destr)(void *, void *))
</td></tr></table></dt>
<div class=
"refcount-info">
<span class=
"label">Return value:
</span>
<span class=
"value">New reference.
</span>
Create a
<tt class=
"ctype">PyCObject
</tt> from the
<tt class=
"ctype">void *
</tt><var>cobj
</var>. The
<var>destr
</var> function will be called when the object is reclaimed.
The
<var>desc
</var> argument can be used to pass extra callback data for
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline"><td><nobr>void*
<b><tt id='l2h-
730' xml:id='l2h-
730'
class=
"cfunction">PyCObject_AsVoidPtr
</tt></b>(
</nobr></td><td>PyObject*
<var>self
</var>)
</td></tr></table></dt>
Return the object
<tt class=
"ctype">void *
</tt> that the
<tt class=
"ctype">PyCObject
</tt>
<var>self
</var> was created with.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline"><td><nobr>void*
<b><tt id='l2h-
731' xml:id='l2h-
731'
class=
"cfunction">PyCObject_GetDesc
</tt></b>(
</nobr></td><td>PyObject*
<var>self
</var>)
</td></tr></table></dt>
Return the description
<tt class=
"ctype">void *
</tt> that the
<tt class=
"ctype">PyCObject
</tt>
<var>self
</var> was created with.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline"><td><nobr>int
<b><tt id='l2h-
732' xml:id='l2h-
732'
class=
"cfunction">PyCObject_SetVoidPtr
</tt></b>(
</nobr></td><td>PyObject*
<var>self
</var>, void*
<var>cobj
</var>)
</td></tr></table></dt>
Set the void pointer inside
<var>self
</var> to
<var>cobj
</var>.
The
<tt class=
"ctype">PyCObject
</tt> must not have an associated destructor.
Return true on success, false on failure.
<div class='online-navigation'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<td class='online-navigation'
><a rel=
"prev" title=
"7.5.8 Weak Reference Objects"
href=
"weakref-objects.html"><img src='../icons/previous.png'
border='
0' height='
32' alt='Previous Page' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"parent" title=
"7.5 Other Objects"
href=
"otherObjects.html"><img src='../icons/up.png'
border='
0' height='
32' alt='Up One Level' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"next" title=
"7.5.10 Cell Objects"
href=
"cell-objects.html"><img src='../icons/next.png'
border='
0' height='
32' alt='Next Page' width='
32'
/></A></td>
<td align=
"center" width=
"100%">Python/C API Reference Manual
</td>
<td class='online-navigation'
><a rel=
"contents" title=
"Table of Contents"
href=
"contents.html"><img src='../icons/contents.png'
border='
0' height='
32' alt='Contents' width='
32'
/></A></td>
<td class='online-navigation'
><img src='../icons/blank.png'
border='
0' height='
32' alt='' width='
32'
/></td>
<td class='online-navigation'
><a rel=
"index" title=
"Index"
href=
"genindex.html"><img src='../icons/index.png'
border='
0' height='
32' alt='Index' width='
32'
/></A></td>
<div class='online-navigation'
>
<b class=
"navlabel">Previous:
</b>
<a class=
"sectref" rel=
"prev" href=
"weakref-objects.html">7.5.8 Weak Reference Objects
</A>
<b class=
"navlabel">Up:
</b>
<a class=
"sectref" rel=
"parent" href=
"otherObjects.html">7.5 Other Objects
</A>
<b class=
"navlabel">Next:
</b>
<a class=
"sectref" rel=
"next" href=
"cell-objects.html">7.5.10 Cell Objects
</A>
<span class=
"release-info">Release
2.4.2, documentation updated on
28 September
2005.
</span>
<!--End of Navigation Panel-->
See
<i><a href=
"about.html">About this document...
</a></i> for information on suggesting changes.