Initial commit of OpenSPARC T2 architecture model.
[OpenSPARC-T2-SAM] / sam-t2 / devtools / amd64 / html / python / lib / dl-objects.html
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<link rel="STYLESHEET" href="lib.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="lib.html" title='Python Library Reference' />
<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="prev" href="module-dl.html" />
<link rel="parent" href="module-dl.html" />
<link rel="next" href="module-dbm.html" />
<meta name='aesop' content='information' />
<title>8.5.1 Dl Objects </title>
</head>
<body>
<DIV CLASS="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="8.5 dl "
href="module-dl.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="8.5 dl "
href="module-dl.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="8.6 dbm "
href="module-dbm.html"><img src='../icons/next.png'
border='0' height='32' alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Python Library Reference</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'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
border='0' height='32' alt='Module Index' width='32' /></a></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>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="module-dl.html">8.5 dl </A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-dl.html">8.5 dl </A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="module-dbm.html">8.6 dbm </A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->
<H2><A NAME="SECTION0010510000000000000000"></A><A NAME="dl-objects"></A>
<BR>
8.5.1 Dl Objects
</H2>
<P>
Dl objects, as returned by <tt class="function">open()</tt> above, have the
following methods:
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-2992' xml:id='l2h-2992' class="method">close</tt></b>(</nobr></td>
<td><var></var>)</td></tr></table></dt>
<dd>
Free all resources, except the memory.
</dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-2993' xml:id='l2h-2993' class="method">sym</tt></b>(</nobr></td>
<td><var>name</var>)</td></tr></table></dt>
<dd>
Return the pointer for the function named <var>name</var>, as a number, if
it exists in the referenced shared object, otherwise <code>None</code>. This
is useful in code like:
<P>
<div class="verbatim"><pre>
&gt;&gt;&gt; if a.sym('time'):
... a.call('time')
... else:
... time.time()
</pre></div>
<P>
(Note that this function will return a non-zero number, as zero is the
<tt class="constant">NULL</tt> pointer)
</dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-2994' xml:id='l2h-2994' class="method">call</tt></b>(</nobr></td>
<td><var>name</var><big>[</big><var>, arg1</var><big>[</big><var>, arg2...</var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
Call the function named <var>name</var> in the referenced shared object.
The arguments must be either Python integers, which will be
passed as is, Python strings, to which a pointer will be passed,
or <code>None</code>, which will be passed as <tt class="constant">NULL</tt>. Note that
strings should only be passed to functions as <tt class="ctype">const char*</tt>, as
Python will not like its string mutated.
<P>
There must be at most 10 arguments, and arguments not given will be
treated as <code>None</code>. The function's return value must be a C
<tt class="ctype">long</tt>, which is a Python integer.
</dl>
<DIV CLASS="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="8.5 dl "
href="module-dl.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="8.5 dl "
href="module-dl.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="8.6 dbm "
href="module-dbm.html"><img src='../icons/next.png'
border='0' height='32' alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Python Library Reference</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'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
border='0' height='32' alt='Module Index' width='32' /></a></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>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="module-dl.html">8.5 dl </A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-dl.html">8.5 dl </A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="module-dbm.html">8.6 dbm </A>
</div>
</div>
<hr />
<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
</DIV>
<!--End of Navigation Panel-->
<ADDRESS>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</ADDRESS>
</BODY>
</HTML>