source: OGRE/trunk/ogrenew/Docs/api/html/classOgre_1_1DynLib.html @ 692

Revision 692, 15.3 KB checked in by mattausch, 18 years ago (diff)

adding ogre 1.2 and dependencies
Line 
1<html>
2<head>
3<title>Ogre::DynLib class Reference - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
4<link type="text/css" rel="stylesheet" href="style.css">
5</head>
6
7<body>
8<!-- Generated by Doxygen 1.3.6 -->
9<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
10<h1>Ogre::DynLib Class Reference</h1><a class="el" href="classOgre_1_1Resource.html">Resource</a> holding data about a dynamic library. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreDynLib_8h-source.html">OgreDynLib.h</a>&gt;</code>
14<p>
15<a href="classOgre_1_1DynLib-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
16<tr><td></td></tr>
17<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
18<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1DynLib.html#Ogre_1_1DynLiba0">DynLib</a> (const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;name)</td></tr>
19
20<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor - used by <a class="el" href="classOgre_1_1DynLibManager.html">DynLibManager</a>.  <a href="#Ogre_1_1DynLiba0"></a><br><br></td></tr>
21<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1DynLib.html#Ogre_1_1DynLiba1">~DynLib</a> ()</td></tr>
22
23<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default destructor.  <a href="#Ogre_1_1DynLiba1"></a><br><br></td></tr>
24<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1DynLib.html#Ogre_1_1DynLiba2">load</a> ()</td></tr>
25
26<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Load the library.  <a href="#Ogre_1_1DynLiba2"></a><br><br></td></tr>
27<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1DynLib.html#Ogre_1_1DynLiba3">unload</a> ()</td></tr>
28
29<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Unload the library.  <a href="#Ogre_1_1DynLiba3"></a><br><br></td></tr>
30<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1DynLib.html#Ogre_1_1DynLiba4">getName</a> (void) const </td></tr>
31
32<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the name of the library.  <a href="#Ogre_1_1DynLiba4"></a><br><br></td></tr>
33<tr><td class="memItemLeft" nowrap align=right valign=top>void *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1DynLib.html#Ogre_1_1DynLiba5">getSymbol</a> (const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;strName) const   throw ()</td></tr>
34
35<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the address of the given symbol from the loaded library.  <a href="#Ogre_1_1DynLiba5"></a><br><br></td></tr>
36<tr><td colspan=2><br><h2>Protected Member Functions</h2></td></tr>
37<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a471">String</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1DynLib.html#Ogre_1_1DynLibb0">dynlibError</a> (void)</td></tr>
38
39<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the last loading error.  <a href="#Ogre_1_1DynLibb0"></a><br><br></td></tr>
40<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
41<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a471">String</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1DynLib.html#Ogre_1_1DynLibp0">mName</a></td></tr>
42
43<tr><td class="memItemLeft" nowrap align=right valign=top>DYNLIB_HANDLE&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1DynLib.html#Ogre_1_1DynLibp1">m_hInst</a></td></tr>
44
45<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Handle to the loaded library.  <a href="#Ogre_1_1DynLibp1"></a><br><br></td></tr>
46</table>
47<hr><a name="_details"></a><h2>Detailed Description</h2>
48<a class="el" href="classOgre_1_1Resource.html">Resource</a> holding data about a dynamic library.
49<p>
50<dl compact><dt><b>Remarks:</b></dt><dd>This class holds the data required to get symbols from libraries loaded at run-time (i.e. from DLL's for so's) </dd></dl>
51<dl compact><dt><b>Author:</b></dt><dd>Adrian Cearnãu (<a href="mailto:cearny@cearny.ro">cearny@cearny.ro</a>) </dd></dl>
52<dl compact><dt><b>Since:</b></dt><dd>27 January 2002 </dd></dl>
53<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classOgre_1_1Resource.html">Resource</a> </dd></dl>
54
55<p>
56
57<p>
58Definition at line <a class="el" href="OgreDynLib_8h-source.html#l00065">65</a> of file <a class="el" href="OgreDynLib_8h-source.html">OgreDynLib.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
59<a class="anchor" name="Ogre_1_1DynLiba0" doxytag="Ogre::DynLib::DynLib" ></a><p>
60<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
61  <tr>
62    <td class="mdRow">
63      <table cellpadding="0" cellspacing="0" border="0">
64        <tr>
65          <td class="md" nowrap valign="top"> Ogre::DynLib::DynLib </td>
66          <td class="md" valign="top">(&nbsp;</td>
67          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td>
68          <td class="mdname1" valign="top" nowrap> <em>name</em>          </td>
69          <td class="md" valign="top">&nbsp;)&nbsp;</td>
70          <td class="md" nowrap></td>
71        </tr>
72
73      </table>
74    </td>
75  </tr>
76</table>
77<table cellspacing=5 cellpadding=0 border=0>
78  <tr>
79    <td>
80      &nbsp;
81    </td>
82    <td>
83
84<p>
85Default constructor - used by <a class="el" href="classOgre_1_1DynLibManager.html">DynLibManager</a>.
86<p>
87<dl compact><dt><b>Warning:</b></dt><dd>Do not call directly </dd></dl>
88    </td>
89  </tr>
90</table>
91<a class="anchor" name="Ogre_1_1DynLiba1" doxytag="Ogre::DynLib::~DynLib" ></a><p>
92<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
93  <tr>
94    <td class="mdRow">
95      <table cellpadding="0" cellspacing="0" border="0">
96        <tr>
97          <td class="md" nowrap valign="top"> Ogre::DynLib::~<a class="el" href="classOgre_1_1DynLib.html">DynLib</a> </td>
98          <td class="md" valign="top">(&nbsp;</td>
99          <td class="mdname1" valign="top" nowrap>          </td>
100          <td class="md" valign="top">&nbsp;)&nbsp;</td>
101          <td class="md" nowrap></td>
102        </tr>
103
104      </table>
105    </td>
106  </tr>
107</table>
108<table cellspacing=5 cellpadding=0 border=0>
109  <tr>
110    <td>
111      &nbsp;
112    </td>
113    <td>
114
115<p>
116Default destructor.
117<p>
118    </td>
119  </tr>
120</table>
121<hr><h2>Member Function Documentation</h2>
122<a class="anchor" name="Ogre_1_1DynLibb0" doxytag="Ogre::DynLib::dynlibError" ></a><p>
123<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
124  <tr>
125    <td class="mdRow">
126      <table cellpadding="0" cellspacing="0" border="0">
127        <tr>
128          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a471">String</a> Ogre::DynLib::dynlibError </td>
129          <td class="md" valign="top">(&nbsp;</td>
130          <td class="md" nowrap valign="top">void&nbsp;</td>
131          <td class="mdname1" valign="top" nowrap>          </td>
132          <td class="md" valign="top">&nbsp;)&nbsp;</td>
133          <td class="md" nowrap><code> [protected]</code></td>
134        </tr>
135
136      </table>
137    </td>
138  </tr>
139</table>
140<table cellspacing=5 cellpadding=0 border=0>
141  <tr>
142    <td>
143      &nbsp;
144    </td>
145    <td>
146
147<p>
148Gets the last loading error.
149<p>
150    </td>
151  </tr>
152</table>
153<a class="anchor" name="Ogre_1_1DynLiba4" doxytag="Ogre::DynLib::getName" ></a><p>
154<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
155  <tr>
156    <td class="mdRow">
157      <table cellpadding="0" cellspacing="0" border="0">
158        <tr>
159          <td class="md" nowrap valign="top"> const <a class="el" href="namespaceOgre.html#a471">String</a>&amp; Ogre::DynLib::getName </td>
160          <td class="md" valign="top">(&nbsp;</td>
161          <td class="md" nowrap valign="top">void&nbsp;</td>
162          <td class="mdname1" valign="top" nowrap>          </td>
163          <td class="md" valign="top">&nbsp;)&nbsp;</td>
164          <td class="md" nowrap> const</td>
165        </tr>
166
167      </table>
168    </td>
169  </tr>
170</table>
171<table cellspacing=5 cellpadding=0 border=0>
172  <tr>
173    <td>
174      &nbsp;
175    </td>
176    <td>
177
178<p>
179Get the name of the library.
180<p>
181
182<p>
183Definition at line <a class="el" href="OgreDynLib_8h-source.html#l00089">89</a> of file <a class="el" href="OgreDynLib_8h-source.html">OgreDynLib.h</a>.
184<p>
185References <a class="el" href="OgrePrerequisites_8h-source.html#l00156">Ogre::String</a>.    </td>
186  </tr>
187</table>
188<a class="anchor" name="Ogre_1_1DynLiba5" doxytag="Ogre::DynLib::getSymbol" ></a><p>
189<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
190  <tr>
191    <td class="mdRow">
192      <table cellpadding="0" cellspacing="0" border="0">
193        <tr>
194          <td class="md" nowrap valign="top"> void* Ogre::DynLib::getSymbol </td>
195          <td class="md" valign="top">(&nbsp;</td>
196          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td>
197          <td class="mdname1" valign="top" nowrap> <em>strName</em>          </td>
198          <td class="md" valign="top">&nbsp;)&nbsp;</td>
199          <td class="md" nowrap> const  throw ()</td>
200        </tr>
201
202      </table>
203    </td>
204  </tr>
205</table>
206<table cellspacing=5 cellpadding=0 border=0>
207  <tr>
208    <td>
209      &nbsp;
210    </td>
211    <td>
212
213<p>
214Returns the address of the given symbol from the loaded library.
215<p>
216<dl compact><dt><b>Parameters:</b></dt><dd>
217  <table border="0" cellspacing="2" cellpadding="0">
218    <tr><td valign=top><em>strName</em>&nbsp;</td><td>The name of the symbol to search for </td></tr>
219  </table>
220</dl>
221<dl compact><dt><b>Returns:</b></dt><dd>If the function succeeds, the returned value is a handle to the symbol. </dd></dl>
222<dl compact><dt><b></b></dt><dd>If the function fails, the returned value is <b>NULL</b>. </dd></dl>
223    </td>
224  </tr>
225</table>
226<a class="anchor" name="Ogre_1_1DynLiba2" doxytag="Ogre::DynLib::load" ></a><p>
227<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
228  <tr>
229    <td class="mdRow">
230      <table cellpadding="0" cellspacing="0" border="0">
231        <tr>
232          <td class="md" nowrap valign="top"> void Ogre::DynLib::load </td>
233          <td class="md" valign="top">(&nbsp;</td>
234          <td class="mdname1" valign="top" nowrap>          </td>
235          <td class="md" valign="top">&nbsp;)&nbsp;</td>
236          <td class="md" nowrap></td>
237        </tr>
238
239      </table>
240    </td>
241  </tr>
242</table>
243<table cellspacing=5 cellpadding=0 border=0>
244  <tr>
245    <td>
246      &nbsp;
247    </td>
248    <td>
249
250<p>
251Load the library.
252<p>
253    </td>
254  </tr>
255</table>
256<a class="anchor" name="Ogre_1_1DynLiba3" doxytag="Ogre::DynLib::unload" ></a><p>
257<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
258  <tr>
259    <td class="mdRow">
260      <table cellpadding="0" cellspacing="0" border="0">
261        <tr>
262          <td class="md" nowrap valign="top"> void Ogre::DynLib::unload </td>
263          <td class="md" valign="top">(&nbsp;</td>
264          <td class="mdname1" valign="top" nowrap>          </td>
265          <td class="md" valign="top">&nbsp;)&nbsp;</td>
266          <td class="md" nowrap></td>
267        </tr>
268
269      </table>
270    </td>
271  </tr>
272</table>
273<table cellspacing=5 cellpadding=0 border=0>
274  <tr>
275    <td>
276      &nbsp;
277    </td>
278    <td>
279
280<p>
281Unload the library.
282<p>
283    </td>
284  </tr>
285</table>
286<hr><h2>Member Data Documentation</h2>
287<a class="anchor" name="Ogre_1_1DynLibp1" doxytag="Ogre::DynLib::m_hInst" ></a><p>
288<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
289  <tr>
290    <td class="mdRow">
291      <table cellpadding="0" cellspacing="0" border="0">
292        <tr>
293          <td class="md" nowrap valign="top"> DYNLIB_HANDLE <a class="el" href="classOgre_1_1DynLib.html#Ogre_1_1DynLibp1">Ogre::DynLib::m_hInst</a><code> [protected]</code>
294      </table>
295    </td>
296  </tr>
297</table>
298<table cellspacing=5 cellpadding=0 border=0>
299  <tr>
300    <td>
301      &nbsp;
302    </td>
303    <td>
304
305<p>
306Handle to the loaded library.
307<p>
308
309<p>
310Definition at line <a class="el" href="OgreDynLib_8h-source.html#l00107">107</a> of file <a class="el" href="OgreDynLib_8h-source.html">OgreDynLib.h</a>.    </td>
311  </tr>
312</table>
313<a class="anchor" name="Ogre_1_1DynLibp0" doxytag="Ogre::DynLib::mName" ></a><p>
314<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
315  <tr>
316    <td class="mdRow">
317      <table cellpadding="0" cellspacing="0" border="0">
318        <tr>
319          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a471">String</a> <a class="el" href="classOgre_1_1DynLib.html#Ogre_1_1DynLibp0">Ogre::DynLib::mName</a><code> [protected]</code>
320      </table>
321    </td>
322  </tr>
323</table>
324<table cellspacing=5 cellpadding=0 border=0>
325  <tr>
326    <td>
327      &nbsp;
328    </td>
329    <td>
330
331<p>
332
333<p>
334Definition at line <a class="el" href="OgreDynLib_8h-source.html#l00068">68</a> of file <a class="el" href="OgreDynLib_8h-source.html">OgreDynLib.h</a>.    </td>
335  </tr>
336</table>
337<hr>The documentation for this class was generated from the following file:<ul>
338<li><a class="el" href="OgreDynLib_8h-source.html">OgreDynLib.h</a></ul>
339<hr>
340<p>
341Copyright &copy; 2000-2005 by The OGRE Team<br />
342<!--Creative Commons License--><a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/"><img alt="Creative Commons License" border="0" src="http://creativecommons.org/images/public/somerights20.png"/></a><br/>
343This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/">Creative Commons Attribution-ShareAlike 2.5 License</a>.<br/>
344                <!--/Creative Commons License--><!-- <rdf:RDF xmlns="http://web.resource.org/cc/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
345                <Work rdf:about="">
346                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
347        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
348                </Work>
349                <License rdf:about="http://creativecommons.org/licenses/by-sa/2.5/"><permits rdf:resource="http://web.resource.org/cc/Reproduction"/><permits rdf:resource="http://web.resource.org/cc/Distribution"/><requires rdf:resource="http://web.resource.org/cc/Notice"/><requires rdf:resource="http://web.resource.org/cc/Attribution"/><permits rdf:resource="http://web.resource.org/cc/DerivativeWorks"/><requires rdf:resource="http://web.resource.org/cc/ShareAlike"/></License></rdf:RDF> -->
350
351Last modified Sun Mar 12 14:38:41 2006
352</p>
353</body>
354</html>
Note: See TracBrowser for help on using the repository browser.