Initial commit of OpenSPARC T2 architecture model.
[OpenSPARC-T2-SAM] / sam-t2 / devtools / v8plus / html / python / lib / dl-objects.html
CommitLineData
920dae64
AT
1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2<html>
3<head>
4<link rel="STYLESHEET" href="lib.css" type='text/css' />
5<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
6<link rel='start' href='../index.html' title='Python Documentation Index' />
7<link rel="first" href="lib.html" title='Python Library Reference' />
8<link rel='contents' href='contents.html' title="Contents" />
9<link rel='index' href='genindex.html' title='Index' />
10<link rel='last' href='about.html' title='About this document...' />
11<link rel='help' href='about.html' title='About this document...' />
12<link rel="prev" href="module-dl.html" />
13<link rel="parent" href="module-dl.html" />
14<link rel="next" href="module-dbm.html" />
15<meta name='aesop' content='information' />
16<title>8.5.1 Dl Objects </title>
17</head>
18<body>
19<DIV CLASS="navigation">
20<div id='top-navigation-panel' xml:id='top-navigation-panel'>
21<table align="center" width="100%" cellpadding="0" cellspacing="2">
22<tr>
23<td class='online-navigation'><a rel="prev" title="8.5 dl "
24 href="module-dl.html"><img src='../icons/previous.png'
25 border='0' height='32' alt='Previous Page' width='32' /></A></td>
26<td class='online-navigation'><a rel="parent" title="8.5 dl "
27 href="module-dl.html"><img src='../icons/up.png'
28 border='0' height='32' alt='Up One Level' width='32' /></A></td>
29<td class='online-navigation'><a rel="next" title="8.6 dbm "
30 href="module-dbm.html"><img src='../icons/next.png'
31 border='0' height='32' alt='Next Page' width='32' /></A></td>
32<td align="center" width="100%">Python Library Reference</td>
33<td class='online-navigation'><a rel="contents" title="Table of Contents"
34 href="contents.html"><img src='../icons/contents.png'
35 border='0' height='32' alt='Contents' width='32' /></A></td>
36<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
37 border='0' height='32' alt='Module Index' width='32' /></a></td>
38<td class='online-navigation'><a rel="index" title="Index"
39 href="genindex.html"><img src='../icons/index.png'
40 border='0' height='32' alt='Index' width='32' /></A></td>
41</tr></table>
42<div class='online-navigation'>
43<b class="navlabel">Previous:</b>
44<a class="sectref" rel="prev" href="module-dl.html">8.5 dl </A>
45<b class="navlabel">Up:</b>
46<a class="sectref" rel="parent" href="module-dl.html">8.5 dl </A>
47<b class="navlabel">Next:</b>
48<a class="sectref" rel="next" href="module-dbm.html">8.6 dbm </A>
49</div>
50<hr /></div>
51</DIV>
52<!--End of Navigation Panel-->
53
54<H2><A NAME="SECTION0010510000000000000000"></A><A NAME="dl-objects"></A>
55<BR>
568.5.1 Dl Objects
57</H2>
58
59<P>
60Dl objects, as returned by <tt class="function">open()</tt> above, have the
61following methods:
62
63<P>
64<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
65 <td><nobr><b><tt id='l2h-2992' xml:id='l2h-2992' class="method">close</tt></b>(</nobr></td>
66 <td><var></var>)</td></tr></table></dt>
67<dd>
68Free all resources, except the memory.
69</dl>
70
71<P>
72<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
73 <td><nobr><b><tt id='l2h-2993' xml:id='l2h-2993' class="method">sym</tt></b>(</nobr></td>
74 <td><var>name</var>)</td></tr></table></dt>
75<dd>
76Return the pointer for the function named <var>name</var>, as a number, if
77it exists in the referenced shared object, otherwise <code>None</code>. This
78is useful in code like:
79
80<P>
81<div class="verbatim"><pre>
82&gt;&gt;&gt; if a.sym('time'):
83... a.call('time')
84... else:
85... time.time()
86</pre></div>
87
88<P>
89(Note that this function will return a non-zero number, as zero is the
90<tt class="constant">NULL</tt> pointer)
91</dl>
92
93<P>
94<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
95 <td><nobr><b><tt id='l2h-2994' xml:id='l2h-2994' class="method">call</tt></b>(</nobr></td>
96 <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>
97<dd>
98Call the function named <var>name</var> in the referenced shared object.
99The arguments must be either Python integers, which will be
100passed as is, Python strings, to which a pointer will be passed,
101or <code>None</code>, which will be passed as <tt class="constant">NULL</tt>. Note that
102strings should only be passed to functions as <tt class="ctype">const char*</tt>, as
103Python will not like its string mutated.
104
105<P>
106There must be at most 10 arguments, and arguments not given will be
107treated as <code>None</code>. The function's return value must be a C
108<tt class="ctype">long</tt>, which is a Python integer.
109</dl>
110
111<DIV CLASS="navigation">
112<div class='online-navigation'>
113<p></p><hr />
114<table align="center" width="100%" cellpadding="0" cellspacing="2">
115<tr>
116<td class='online-navigation'><a rel="prev" title="8.5 dl "
117 href="module-dl.html"><img src='../icons/previous.png'
118 border='0' height='32' alt='Previous Page' width='32' /></A></td>
119<td class='online-navigation'><a rel="parent" title="8.5 dl "
120 href="module-dl.html"><img src='../icons/up.png'
121 border='0' height='32' alt='Up One Level' width='32' /></A></td>
122<td class='online-navigation'><a rel="next" title="8.6 dbm "
123 href="module-dbm.html"><img src='../icons/next.png'
124 border='0' height='32' alt='Next Page' width='32' /></A></td>
125<td align="center" width="100%">Python Library Reference</td>
126<td class='online-navigation'><a rel="contents" title="Table of Contents"
127 href="contents.html"><img src='../icons/contents.png'
128 border='0' height='32' alt='Contents' width='32' /></A></td>
129<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
130 border='0' height='32' alt='Module Index' width='32' /></a></td>
131<td class='online-navigation'><a rel="index" title="Index"
132 href="genindex.html"><img src='../icons/index.png'
133 border='0' height='32' alt='Index' width='32' /></A></td>
134</tr></table>
135<div class='online-navigation'>
136<b class="navlabel">Previous:</b>
137<a class="sectref" rel="prev" href="module-dl.html">8.5 dl </A>
138<b class="navlabel">Up:</b>
139<a class="sectref" rel="parent" href="module-dl.html">8.5 dl </A>
140<b class="navlabel">Next:</b>
141<a class="sectref" rel="next" href="module-dbm.html">8.6 dbm </A>
142</div>
143</div>
144<hr />
145<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
146</DIV>
147<!--End of Navigation Panel-->
148<ADDRESS>
149See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
150</ADDRESS>
151</BODY>
152</HTML>