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 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359
|
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.9.8" xml:lang="en-US">
<compounddef id="xmlmodule_8c" kind="file" language="C++">
<compoundname>xmlmodule.c</compoundname>
<includes local="yes">libxml.h</includes>
<includes local="no">string.h</includes>
<includes refid="xmlmodule_8h" local="no">libxml/xmlmodule.h</includes>
<includes refid="xmlmemory_8h" local="no">libxml/xmlmemory.h</includes>
<includes refid="xmlerror_8h" local="no">libxml/xmlerror.h</includes>
<includes refid="xmlstring_8h" local="no">libxml/xmlstring.h</includes>
<includes local="yes">private/error.h</includes>
<includes local="no">dlfcn.h</includes>
<incdepgraph>
<node id="9">
<label>libxml/xmlerror.h</label>
<link refid="xmlerror_8h"/>
<childnode refid="5" relation="include">
</childnode>
</node>
<node id="7">
<label>libxml/xmlmemory.h</label>
<link refid="xmlmemory_8h"/>
<childnode refid="8" relation="include">
</childnode>
<childnode refid="5" relation="include">
</childnode>
</node>
<node id="4">
<label>libxml/xmlmodule.h</label>
<link refid="xmlmodule_8h"/>
<childnode refid="5" relation="include">
</childnode>
</node>
<node id="10">
<label>libxml/xmlstring.h</label>
<link refid="xmlstring_8h"/>
<childnode refid="11" relation="include">
</childnode>
<childnode refid="5" relation="include">
</childnode>
</node>
<node id="5">
<label>libxml/xmlversion.h</label>
<link refid="xmlversion_8h"/>
<childnode refid="6" relation="include">
</childnode>
</node>
<node id="1">
<label>/builds/GNOME/libxml2/xmlmodule.c</label>
<link refid="xmlmodule_8c"/>
<childnode refid="2" relation="include">
</childnode>
<childnode refid="3" relation="include">
</childnode>
<childnode refid="4" relation="include">
</childnode>
<childnode refid="7" relation="include">
</childnode>
<childnode refid="9" relation="include">
</childnode>
<childnode refid="10" relation="include">
</childnode>
<childnode refid="12" relation="include">
</childnode>
<childnode refid="13" relation="include">
</childnode>
</node>
<node id="13">
<label>dlfcn.h</label>
</node>
<node id="2">
<label>libxml.h</label>
</node>
<node id="6">
<label>libxml/xmlexports.h</label>
</node>
<node id="12">
<label>private/error.h</label>
</node>
<node id="11">
<label>stdarg.h</label>
</node>
<node id="8">
<label>stdio.h</label>
</node>
<node id="3">
<label>string.h</label>
</node>
</incdepgraph>
<innerclass refid="struct__xmlModule" prot="public">_xmlModule</innerclass>
<sectiondef kind="define">
<memberdef kind="define" id="xmlmodule_8c_1a2e0dfa3e1bcca0ce16dfbe14da3a27be" prot="public" static="no">
<name>IN_LIBXML</name>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/builds/GNOME/libxml2/xmlmodule.c" line="16" column="9" bodyfile="/builds/GNOME/libxml2/xmlmodule.c" bodystart="16" bodyend="-1"/>
</memberdef>
<memberdef kind="define" id="xmlmodule_8c_1ace65454279c135fe5e6168d456c31263" prot="public" static="no">
<name>RTLD_GLOBAL</name>
<initializer>0</initializer>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/builds/GNOME/libxml2/xmlmodule.c" line="165" column="9" bodyfile="/builds/GNOME/libxml2/xmlmodule.c" bodystart="165" bodyend="-1"/>
</memberdef>
</sectiondef>
<sectiondef kind="func">
<memberdef kind="function" id="xmlmodule_8c_1a4cd199349e6599bb83e226bec20de0f6" prot="public" static="yes" const="no" explicit="no" inline="no" virt="non-virtual">
<type>void *</type>
<definition>static void * xmlModulePlatformOpen</definition>
<argsstring>(const char *name)</argsstring>
<name>xmlModulePlatformOpen</name>
<param>
<type>const char *</type>
<declname>name</declname>
</param>
<briefdescription>
</briefdescription>
<detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>name</parametername>
</parameternamelist>
<parameterdescription>
<para>path to the module </para>
</parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>a handle on success, and zero on error. </para>
</simplesect>
</para>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/builds/GNOME/libxml2/xmlmodule.c" line="174" column="1" bodyfile="/builds/GNOME/libxml2/xmlmodule.c" bodystart="174" bodyend="177" declfile="/builds/GNOME/libxml2/xmlmodule.c" declline="34" declcolumn="13"/>
</memberdef>
<memberdef kind="function" id="xmlmodule_8c_1aef215573eb9763910e9010bbfd6876e5" prot="public" static="yes" const="no" explicit="no" inline="no" virt="non-virtual">
<type>int</type>
<definition>static int xmlModulePlatformClose</definition>
<argsstring>(void *handle)</argsstring>
<name>xmlModulePlatformClose</name>
<param>
<type>void *</type>
<declname>handle</declname>
</param>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/builds/GNOME/libxml2/xmlmodule.c" line="186" column="1" bodyfile="/builds/GNOME/libxml2/xmlmodule.c" bodystart="186" bodyend="189" declfile="/builds/GNOME/libxml2/xmlmodule.c" declline="35" declcolumn="12"/>
</memberdef>
<memberdef kind="function" id="xmlmodule_8c_1a34e2956575918548161607fa107c04ae" prot="public" static="yes" const="no" explicit="no" inline="no" virt="non-virtual">
<type>int</type>
<definition>static int xmlModulePlatformSymbol</definition>
<argsstring>(void *handle, const char *name, void **result)</argsstring>
<name>xmlModulePlatformSymbol</name>
<param>
<type>void *</type>
<declname>handle</declname>
</param>
<param>
<type>const char *</type>
<declname>name</declname>
</param>
<param>
<type>void **</type>
<declname>result</declname>
</param>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/builds/GNOME/libxml2/xmlmodule.c" line="198" column="1" bodyfile="/builds/GNOME/libxml2/xmlmodule.c" bodystart="198" bodyend="205" declfile="/builds/GNOME/libxml2/xmlmodule.c" declline="36" declcolumn="12"/>
</memberdef>
<memberdef kind="function" id="xmlmodule_8c_1a98cb88911d2735228f695412d5958fee" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type><ref refid="xmlmodule_8h_1a55930515424d24517ec43731a4955a69" kindref="member">xmlModule</ref> *</type>
<definition>xmlModule * xmlModuleOpen</definition>
<argsstring>(const char *name, int options)</argsstring>
<name>xmlModuleOpen</name>
<param>
<type>const char *</type>
<declname>name</declname>
</param>
<param>
<type>int</type>
<declname>options</declname>
</param>
<briefdescription>
<para>Opens a module/shared library given its name or path. </para>
</briefdescription>
<detaileddescription>
<para><xrefsect id="deprecated_1_deprecated000392"><xreftitle>Deprecated</xreftitle><xrefdescription><para>Will be removed.</para>
</xrefdescription></xrefsect></para>
<para>NOTE: that due to portability issues, behaviour can only be guaranteed with <computeroutput>name</computeroutput> 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.</para>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>name</parametername>
</parameternamelist>
<parameterdescription>
<para>the module name </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>options</parametername>
</parameternamelist>
<parameterdescription>
<para>a set of xmlModuleOption </para>
</parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>a handle for the module or NULL in case of error </para>
</simplesect>
</para>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/builds/GNOME/libxml2/xmlmodule.c" line="60" column="1" bodyfile="/builds/GNOME/libxml2/xmlmodule.c" bodystart="60" bodyend="79"/>
</memberdef>
<memberdef kind="function" id="xmlmodule_8c_1a66cfd72dd23a36e383889ea02824204d" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type>int</type>
<definition>int xmlModuleSymbol</definition>
<argsstring>(xmlModule *module, const char *name, void **symbol)</argsstring>
<name>xmlModuleSymbol</name>
<param>
<type><ref refid="xmlmodule_8h_1a55930515424d24517ec43731a4955a69" kindref="member">xmlModule</ref> *</type>
<declname>module</declname>
</param>
<param>
<type>const char *</type>
<declname>name</declname>
</param>
<param>
<type>void **</type>
<declname>symbol</declname>
</param>
<briefdescription>
<para>Lookup for a symbol address in the given module. </para>
</briefdescription>
<detaileddescription>
<para><xrefsect id="deprecated_1_deprecated000393"><xreftitle>Deprecated</xreftitle><xrefdescription><para>Will be removed.</para>
</xrefdescription></xrefsect></para>
<para>NOTE: that due to portability issues, behaviour can only be guaranteed with <computeroutput>name</computeroutput> 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 * .</para>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>module</parametername>
</parameternamelist>
<parameterdescription>
<para>the module </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>name</parametername>
</parameternamelist>
<parameterdescription>
<para>the name of the symbol </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>symbol</parametername>
</parameternamelist>
<parameterdescription>
<para>the resulting symbol address </para>
</parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>0 if the symbol was found, or -1 in case of error </para>
</simplesect>
</para>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/builds/GNOME/libxml2/xmlmodule.c" line="97" column="1" bodyfile="/builds/GNOME/libxml2/xmlmodule.c" bodystart="97" bodyend="110"/>
</memberdef>
<memberdef kind="function" id="xmlmodule_8c_1a9e84822abde464ae8e3671b66c0e5848" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type>int</type>
<definition>int xmlModuleClose</definition>
<argsstring>(xmlModule *module)</argsstring>
<name>xmlModuleClose</name>
<param>
<type><ref refid="xmlmodule_8h_1a55930515424d24517ec43731a4955a69" kindref="member">xmlModule</ref> *</type>
<declname>module</declname>
</param>
<briefdescription>
<para>The close operations unload the associated module and free the data associated to the module. </para>
</briefdescription>
<detaileddescription>
<para><xrefsect id="deprecated_1_deprecated000394"><xreftitle>Deprecated</xreftitle><xrefdescription><para>Will be removed.</para>
</xrefdescription></xrefsect></para>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>module</parametername>
</parameternamelist>
<parameterdescription>
<para>the module handle </para>
</parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>0 in case of success, -1 in case of argument error and -2 if the module could not be closed/unloaded. </para>
</simplesect>
</para>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/builds/GNOME/libxml2/xmlmodule.c" line="123" column="1" bodyfile="/builds/GNOME/libxml2/xmlmodule.c" bodystart="123" bodyend="137"/>
</memberdef>
<memberdef kind="function" id="xmlmodule_8c_1a67dc559ae72da88b9e769a712bde1a48" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type>int</type>
<definition>int xmlModuleFree</definition>
<argsstring>(xmlModule *module)</argsstring>
<name>xmlModuleFree</name>
<param>
<type><ref refid="xmlmodule_8h_1a55930515424d24517ec43731a4955a69" kindref="member">xmlModule</ref> *</type>
<declname>module</declname>
</param>
<briefdescription>
<para>The free operations free the data associated to the module but does not unload the associated shared library which may still be in use. </para>
</briefdescription>
<detaileddescription>
<para><xrefsect id="deprecated_1_deprecated000395"><xreftitle>Deprecated</xreftitle><xrefdescription><para>Will be removed.</para>
</xrefdescription></xrefsect></para>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>module</parametername>
</parameternamelist>
<parameterdescription>
<para>the module handle </para>
</parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>0 in case of success, -1 in case of argument error </para>
</simplesect>
</para>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/builds/GNOME/libxml2/xmlmodule.c" line="150" column="1" bodyfile="/builds/GNOME/libxml2/xmlmodule.c" bodystart="150" bodyend="159"/>
</memberdef>
</sectiondef>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<location file="/builds/GNOME/libxml2/xmlmodule.c"/>
</compounddef>
</doxygen>
|