/usr/share/doc/libjuce/apiref/classDynamicLibrary.html is in libjuce-doc 4.3.0~repack-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 | <!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>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>JUCE: DynamicLibrary Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">JUCE
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classDynamicLibrary-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">DynamicLibrary Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Handles the opening and closing of DLLs.
<a href="classDynamicLibrary.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a7c6a13e65177869af7116175c7745e2e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDynamicLibrary.html#a7c6a13e65177869af7116175c7745e2e">DynamicLibrary</a> () noexcept</td></tr>
<tr class="memdesc:a7c6a13e65177869af7116175c7745e2e"><td class="mdescLeft"> </td><td class="mdescRight">Creates an unopened <a class="el" href="classDynamicLibrary.html" title="Handles the opening and closing of DLLs. ">DynamicLibrary</a> object. <a href="#a7c6a13e65177869af7116175c7745e2e">More...</a><br /></td></tr>
<tr class="separator:a7c6a13e65177869af7116175c7745e2e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af9ad02ee239000e67ff664ef4b5dfe2c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDynamicLibrary.html#af9ad02ee239000e67ff664ef4b5dfe2c">DynamicLibrary</a> (const <a class="el" href="classString.html">String</a> &name)</td></tr>
<tr class="separator:af9ad02ee239000e67ff664ef4b5dfe2c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a25dd7a7cd386fbc1c8abde597c39c881"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDynamicLibrary.html#a25dd7a7cd386fbc1c8abde597c39c881">~DynamicLibrary</a> ()</td></tr>
<tr class="memdesc:a25dd7a7cd386fbc1c8abde597c39c881"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a25dd7a7cd386fbc1c8abde597c39c881">More...</a><br /></td></tr>
<tr class="separator:a25dd7a7cd386fbc1c8abde597c39c881"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab64b6f35270c87d0c69b422854683674"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classDynamicLibrary.html#ab64b6f35270c87d0c69b422854683674">open</a> (const <a class="el" href="classString.html">String</a> &name)</td></tr>
<tr class="memdesc:ab64b6f35270c87d0c69b422854683674"><td class="mdescLeft"> </td><td class="mdescRight">Opens a DLL. <a href="#ab64b6f35270c87d0c69b422854683674">More...</a><br /></td></tr>
<tr class="separator:ab64b6f35270c87d0c69b422854683674"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac894163d2ef226237fd6d6cfaeb77fce"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDynamicLibrary.html#ac894163d2ef226237fd6d6cfaeb77fce">close</a> ()</td></tr>
<tr class="memdesc:ac894163d2ef226237fd6d6cfaeb77fce"><td class="mdescLeft"> </td><td class="mdescRight">Releases the currently-open DLL, or has no effect if none was open. <a href="#ac894163d2ef226237fd6d6cfaeb77fce">More...</a><br /></td></tr>
<tr class="separator:ac894163d2ef226237fd6d6cfaeb77fce"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a278ed4824af45759270b5c1eeba9dcb6"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDynamicLibrary.html#a278ed4824af45759270b5c1eeba9dcb6">getFunction</a> (const <a class="el" href="classString.html">String</a> &functionName) noexcept</td></tr>
<tr class="memdesc:a278ed4824af45759270b5c1eeba9dcb6"><td class="mdescLeft"> </td><td class="mdescRight">Tries to find a named function in the currently-open DLL, and returns a pointer to it. <a href="#a278ed4824af45759270b5c1eeba9dcb6">More...</a><br /></td></tr>
<tr class="separator:a278ed4824af45759270b5c1eeba9dcb6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acf0128264e0070e40f1be2eac26073e4"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDynamicLibrary.html#acf0128264e0070e40f1be2eac26073e4">getNativeHandle</a> () const noexcept</td></tr>
<tr class="memdesc:acf0128264e0070e40f1be2eac26073e4"><td class="mdescLeft"> </td><td class="mdescRight">Returns the platform-specific native library handle. <a href="#acf0128264e0070e40f1be2eac26073e4">More...</a><br /></td></tr>
<tr class="separator:acf0128264e0070e40f1be2eac26073e4"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Handles the opening and closing of DLLs. </p>
<p>This class can be used to open a DLL and get some function pointers from it. Since the DLL is freed when this object is deleted, it's handy for managing library lifetimes using RAII. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a7c6a13e65177869af7116175c7745e2e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7c6a13e65177869af7116175c7745e2e">§ </a></span>DynamicLibrary() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">DynamicLibrary::DynamicLibrary </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates an unopened <a class="el" href="classDynamicLibrary.html" title="Handles the opening and closing of DLLs. ">DynamicLibrary</a> object. </p>
<p>Call <a class="el" href="classDynamicLibrary.html#ab64b6f35270c87d0c69b422854683674" title="Opens a DLL. ">open()</a> to actually open one. </p>
</div>
</div>
<a id="af9ad02ee239000e67ff664ef4b5dfe2c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af9ad02ee239000e67ff664ef4b5dfe2c">§ </a></span>DynamicLibrary() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DynamicLibrary::DynamicLibrary </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a25dd7a7cd386fbc1c8abde597c39c881"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a25dd7a7cd386fbc1c8abde597c39c881">§ </a></span>~DynamicLibrary()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DynamicLibrary::~DynamicLibrary </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
<p>If a library is currently open, it will be closed when this object is destroyed. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ab64b6f35270c87d0c69b422854683674"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab64b6f35270c87d0c69b422854683674">§ </a></span>open()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool DynamicLibrary::open </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Opens a DLL. </p>
<p>The name and the method by which it gets found is of course platform-specific, and may or may not include a path, depending on the OS. If a library is already open when this method is called, it will first close the library before attempting to load the new one. </p><dl class="section return"><dt>Returns</dt><dd>true if the library was successfully found and opened. </dd></dl>
</div>
</div>
<a id="ac894163d2ef226237fd6d6cfaeb77fce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac894163d2ef226237fd6d6cfaeb77fce">§ </a></span>close()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DynamicLibrary::close </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Releases the currently-open DLL, or has no effect if none was open. </p>
</div>
</div>
<a id="a278ed4824af45759270b5c1eeba9dcb6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a278ed4824af45759270b5c1eeba9dcb6">§ </a></span>getFunction()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void* DynamicLibrary::getFunction </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>functionName</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Tries to find a named function in the currently-open DLL, and returns a pointer to it. </p>
<p>If no library is open, or if the function isn't found, this will return a null pointer. </p>
</div>
</div>
<a id="acf0128264e0070e40f1be2eac26073e4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acf0128264e0070e40f1be2eac26073e4">§ </a></span>getNativeHandle()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void* DynamicLibrary::getNativeHandle </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the platform-specific native library handle. </p>
<p>You'll need to cast this to whatever is appropriate for the OS that's in use. </p>
<p>References <a class="el" href="juce__PlatformDefs_8h.html#a851b02724a8158a7f746c66b5758b3dd">JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__DynamicLibrary_8h.html">juce_DynamicLibrary.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|