File: Poco.SharedLibrary.html

package info (click to toggle)
poco-doc 1.3.6-1
  • links: PTS
  • area: main
  • in suites: buster, jessie, jessie-kfreebsd, squeeze, stretch, wheezy
  • size: 10,076 kB
  • ctags: 9,611
  • sloc: makefile: 31
file content (91 lines) | stat: -rw-r--r-- 5,851 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Class Poco::SharedLibrary</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
<meta name="author" content="Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="publisher" content="Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="copyright" content="Copyright (c) 2009, Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="language" content="en"/>
<meta name="date" content="2009-11-24"/>
<meta name="generator" content="PocoDoc"/>
<link rel="stylesheet" href="css/styles.css" type="text/css"/>
</head>
<body bgcolor="#ffffff" leftmargin="0" topmargin="0">
<div class="header">
<h1 class="namespace"><a href="Poco.html" class="namespace">Poco</a></h1>
<h1 class="symbol">class SharedLibrary</h1>
</div>
<div class="body">
<p>
<b>Library:</b> Foundation<br />
<b>Package:</b> SharedLibrary<br />
<b>Header:</b> Poco/SharedLibrary.h</p>
<h2>Description</h2>
<div class="description">
<p>The <a href="Poco.SharedLibrary.html" title="class Poco::SharedLibrary">SharedLibrary</a> class dynamically  loads shared libraries at run-time. </p>
</div>
<h2>Inheritance</h2>
<p><b>Direct Base Classes: </b>SharedLibraryImpl</p>
<p><b>All Base Classes: </b>SharedLibraryImpl</p>
<h2>Member Summary</h2>
<p><b>Member Functions: </b><a href="Poco.SharedLibrary.html#9916" title="Poco::SharedLibrary::getPath()">getPath</a>, <a href="Poco.SharedLibrary.html#9914" title="Poco::SharedLibrary::getSymbol()">getSymbol</a>, <a href="Poco.SharedLibrary.html#9912" title="Poco::SharedLibrary::hasSymbol()">hasSymbol</a>, <a href="Poco.SharedLibrary.html#9911" title="Poco::SharedLibrary::isLoaded()">isLoaded</a>, <a href="Poco.SharedLibrary.html#9908" title="Poco::SharedLibrary::load()">load</a>, <a href="Poco.SharedLibrary.html#9917" title="Poco::SharedLibrary::suffix()">suffix</a>, <a href="Poco.SharedLibrary.html#9910" title="Poco::SharedLibrary::unload()">unload</a></p>
<h2>Constructors</h2>
<h3><a name="9904">SharedLibrary</a></h3>
<p class="decl"><a href="Poco.SharedLibrary.html" title="class Poco::SharedLibrary">SharedLibrary</a>();</p>
<div class="description">
<p>Creates a <a href="Poco.SharedLibrary.html" title="class Poco::SharedLibrary">SharedLibrary</a> object. </p>
</div>
<h3><a name="9905">SharedLibrary</a></h3>
<p class="decl"><a href="Poco.SharedLibrary.html" title="class Poco::SharedLibrary">SharedLibrary</a>(<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; path<br />);</p>
<div class="description">
<p>Creates a <a href="Poco.SharedLibrary.html" title="class Poco::SharedLibrary">SharedLibrary</a> object and loads a library from the given path. </p>
</div>
<h2>Destructor</h2>
<h3><a name="9907">~SharedLibrary</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">virtual ~<a href="Poco.SharedLibrary.html" title="class Poco::SharedLibrary">SharedLibrary</a>();</p>
<div class="description">
<p>Destroys the <a href="Poco.SharedLibrary.html" title="class Poco::SharedLibrary">SharedLibrary</a>. The actual library remains loaded. </p>
</div>
<h2>Member Functions</h2>
<h3><a name="9916">getPath</a></h3>
<p class="decl">const std::string &amp; getPath() const;</p>
<div class="description">
<p>Returns the path of the library, as specified in a call to <a href="Poco.SharedLibrary.html#9908" title="Poco::SharedLibrary::load()">load</a>() or the  constructor. </p>
</div>
<h3><a name="9914">getSymbol</a></h3>
<p class="decl">void * getSymbol(<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; name<br />);</p>
<div class="description">
<p>Returns the address of the symbol with the given name. For functions, this is the entry point of the function. Throws a <a href="Poco.NotFoundException.html" title="class Poco::NotFoundException">NotFoundException</a> if the symbol does not exist. </p>
</div>
<h3><a name="9912">hasSymbol</a></h3>
<p class="decl">bool hasSymbol(<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; name<br />);</p>
<div class="description">
<p>Returns true if and only if the loaded library contains a symbol with the given name. </p>
</div>
<h3><a name="9911">isLoaded</a></h3>
<p class="decl">bool isLoaded() const;</p>
<div class="description">
<p>Returns true if and only if a library has been loaded. </p>
</div>
<h3><a name="9908">load</a></h3>
<p class="decl">void load(<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; path<br />);</p>
<div class="description">
<p>Loads a shared library from the given path. Throws a <a href="Poco.LibraryAlreadyLoadedException.html" title="class Poco::LibraryAlreadyLoadedException">LibraryAlreadyLoadedException</a> if a library has already been loaded. Throws a <a href="Poco.LibraryLoadException.html" title="class Poco::LibraryLoadException">LibraryLoadException</a> if the library cannot be loaded. </p>
</div>
<h3><a name="9917">suffix</a> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static std::string suffix();</p>
<div class="description">
<p>Returns the platform-specific filename suffix for shared libraries (including the period). In debug mode, the suffix also includes a &quot;d&quot; to specify the debug version of a library. </p>
</div>
<h3><a name="9910">unload</a></h3>
<p class="decl">void unload();</p>
<div class="description">
<p>Unloads a shared library. </p>
</div>
<p class="footer">POCO C++ Libraries 1.3.6-all<br />
Copyright &copy; 2009, <a href="http://pocoproject.org/" target="_blank">Applied Informatics Software Engineering GmbH and Contributors</a></p>

</div>
</body>
</html>