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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libxml2: xmlmodule.h File 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" />
<link href="libxml2.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 id="projectrow">
<td id="projectalign">
<div id="projectname">libxml2
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">xmlmodule.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Dynamic module loading.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a55930515424d24517ec43731a4955a69" id="r_a55930515424d24517ec43731a4955a69"><td class="memItemLeft" align="right" valign="top"><a id="a55930515424d24517ec43731a4955a69" name="a55930515424d24517ec43731a4955a69"></a>
typedef struct _xmlModule </td><td class="memItemRight" valign="bottom"><b>xmlModule</b></td></tr>
<tr class="memdesc:a55930515424d24517ec43731a4955a69"><td class="mdescLeft"> </td><td class="mdescRight">A handle to a dynamically loaded module. <br /></td></tr>
<tr class="separator:a55930515424d24517ec43731a4955a69"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a3da2abf53bc0cb57bcc3cc4fa8989162" id="r_a3da2abf53bc0cb57bcc3cc4fa8989162"><td class="memItemLeft" align="right" valign="top"><a id="a3da2abf53bc0cb57bcc3cc4fa8989162" name="a3da2abf53bc0cb57bcc3cc4fa8989162"></a>enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="xmlmodule_8h.html#a3da2abf53bc0cb57bcc3cc4fa8989162">xmlModuleOption</a> </td></tr>
<tr class="memdesc:a3da2abf53bc0cb57bcc3cc4fa8989162"><td class="mdescLeft"> </td><td class="mdescRight">enumeration of options that can be passed down to <a class="el" href="xmlmodule_8h.html#ad1060e845e7984a1af144789b3ca2b67" title="Opens a module/shared library given its name or path.">xmlModuleOpen</a> <br /></td></tr>
<tr class="separator:a3da2abf53bc0cb57bcc3cc4fa8989162"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ad1060e845e7984a1af144789b3ca2b67" id="r_ad1060e845e7984a1af144789b3ca2b67"><td class="memItemLeft" align="right" valign="top"><a class="el" href="xmlmodule_8h.html#a55930515424d24517ec43731a4955a69">xmlModule</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="xmlmodule_8h.html#ad1060e845e7984a1af144789b3ca2b67">xmlModuleOpen</a> (const char *filename, int options)</td></tr>
<tr class="memdesc:ad1060e845e7984a1af144789b3ca2b67"><td class="mdescLeft"> </td><td class="mdescRight">Opens a module/shared library given its name or path. <br /></td></tr>
<tr class="separator:ad1060e845e7984a1af144789b3ca2b67"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a907ca4f0afc57ba6a595bb45644372d5" id="r_a907ca4f0afc57ba6a595bb45644372d5"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xmlmodule_8h.html#a907ca4f0afc57ba6a595bb45644372d5">xmlModuleSymbol</a> (<a class="el" href="xmlmodule_8h.html#a55930515424d24517ec43731a4955a69">xmlModule</a> *module, const char *name, void **result)</td></tr>
<tr class="memdesc:a907ca4f0afc57ba6a595bb45644372d5"><td class="mdescLeft"> </td><td class="mdescRight">Lookup for a symbol address in the given module. <br /></td></tr>
<tr class="separator:a907ca4f0afc57ba6a595bb45644372d5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9e84822abde464ae8e3671b66c0e5848" id="r_a9e84822abde464ae8e3671b66c0e5848"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xmlmodule_8h.html#a9e84822abde464ae8e3671b66c0e5848">xmlModuleClose</a> (<a class="el" href="xmlmodule_8h.html#a55930515424d24517ec43731a4955a69">xmlModule</a> *module)</td></tr>
<tr class="memdesc:a9e84822abde464ae8e3671b66c0e5848"><td class="mdescLeft"> </td><td class="mdescRight">The close operations unload the associated module and free the data associated to the module. <br /></td></tr>
<tr class="separator:a9e84822abde464ae8e3671b66c0e5848"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a67dc559ae72da88b9e769a712bde1a48" id="r_a67dc559ae72da88b9e769a712bde1a48"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xmlmodule_8h.html#a67dc559ae72da88b9e769a712bde1a48">xmlModuleFree</a> (<a class="el" href="xmlmodule_8h.html#a55930515424d24517ec43731a4955a69">xmlModule</a> *module)</td></tr>
<tr class="memdesc:a67dc559ae72da88b9e769a712bde1a48"><td class="mdescLeft"> </td><td class="mdescRight">The free operations free the data associated to the module but does not unload the associated shared library which may still be in use. <br /></td></tr>
<tr class="separator:a67dc559ae72da88b9e769a712bde1a48"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Dynamic module loading. </p>
<p>API for dynamic module loading. Only used by old libxslt versions and subject to removal.</p>
<dl class="section copyright"><dt>Copyright</dt><dd>See Copyright for the status of this software.</dd></dl>
<dl class="section author"><dt>Author</dt><dd>Joel W. Reed </dd></dl>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a9e84822abde464ae8e3671b66c0e5848" name="a9e84822abde464ae8e3671b66c0e5848"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9e84822abde464ae8e3671b66c0e5848">◆ </a></span>xmlModuleClose()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int xmlModuleClose </td>
<td>(</td>
<td class="paramtype"><a class="el" href="xmlmodule_8h.html#a55930515424d24517ec43731a4955a69">xmlModule</a> * </td>
<td class="paramname"><em>module</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>The close operations unload the associated module and free the data associated to the module. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000394">Deprecated:</a></b></dt><dd>Will be removed.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">module</td><td>the module handle </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 in case of success, -1 in case of argument error and -2 if the module could not be closed/unloaded. </dd></dl>
</div>
</div>
<a id="a67dc559ae72da88b9e769a712bde1a48" name="a67dc559ae72da88b9e769a712bde1a48"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a67dc559ae72da88b9e769a712bde1a48">◆ </a></span>xmlModuleFree()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int xmlModuleFree </td>
<td>(</td>
<td class="paramtype"><a class="el" href="xmlmodule_8h.html#a55930515424d24517ec43731a4955a69">xmlModule</a> * </td>
<td class="paramname"><em>module</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>The free operations free the data associated to the module but does not unload the associated shared library which may still be in use. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000395">Deprecated:</a></b></dt><dd>Will be removed.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">module</td><td>the module handle </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 in case of success, -1 in case of argument error </dd></dl>
</div>
</div>
<a id="ad1060e845e7984a1af144789b3ca2b67" name="ad1060e845e7984a1af144789b3ca2b67"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad1060e845e7984a1af144789b3ca2b67">◆ </a></span>xmlModuleOpen()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="xmlmodule_8h.html#a55930515424d24517ec43731a4955a69">xmlModule</a> * xmlModuleOpen </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>options</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Opens a module/shared library given its name or path. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000392">Deprecated:</a></b></dt><dd>Will be removed.</dd></dl>
<p>NOTE: that due to portability issues, behaviour can only be guaranteed with <code>name</code> using ASCII. We cannot guarantee that an UTF-8 string would work, which is why name is a const char * and not a const xmlChar * . TODO: options are not yet implemented.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>the module name </td></tr>
<tr><td class="paramname">options</td><td>a set of xmlModuleOption </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a handle for the module or NULL in case of error </dd></dl>
</div>
</div>
<a id="a907ca4f0afc57ba6a595bb45644372d5" name="a907ca4f0afc57ba6a595bb45644372d5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a907ca4f0afc57ba6a595bb45644372d5">◆ </a></span>xmlModuleSymbol()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int xmlModuleSymbol </td>
<td>(</td>
<td class="paramtype"><a class="el" href="xmlmodule_8h.html#a55930515424d24517ec43731a4955a69">xmlModule</a> * </td>
<td class="paramname"><em>module</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void ** </td>
<td class="paramname"><em>symbol</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Lookup for a symbol address in the given module. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000393">Deprecated:</a></b></dt><dd>Will be removed.</dd></dl>
<p>NOTE: that due to portability issues, behaviour can only be guaranteed with <code>name</code> using ASCII. We cannot guarantee that an UTF-8 string would work, which is why name is a const char * and not a const xmlChar * .</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">module</td><td>the module </td></tr>
<tr><td class="paramname">name</td><td>the name of the symbol </td></tr>
<tr><td class="paramname">symbol</td><td>the resulting symbol address </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if the symbol was found, or -1 in case of error </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>
|