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
|
<?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_8h" kind="file" language="C++">
<compoundname>xmlmodule.h</compoundname>
<includes refid="xmlversion_8h" local="no">libxml/xmlversion.h</includes>
<includedby refid="xmlmodule_8c" local="no">/builds/GNOME/libxml2/xmlmodule.c</includedby>
<incdepgraph>
<node id="1">
<label>xmlmodule.h</label>
<link refid="xmlmodule_8h"/>
<childnode refid="2" relation="include">
</childnode>
</node>
<node id="2">
<label>libxml/xmlversion.h</label>
<link refid="xmlversion_8h"/>
<childnode refid="3" relation="include">
</childnode>
</node>
<node id="3">
<label>libxml/xmlexports.h</label>
</node>
</incdepgraph>
<sectiondef kind="enum">
<memberdef kind="enum" id="xmlmodule_8h_1a3da2abf53bc0cb57bcc3cc4fa8989162" prot="public" static="no" strong="no">
<type></type>
<name>xmlModuleOption</name>
<enumvalue id="xmlmodule_8h_1a3da2abf53bc0cb57bcc3cc4fa8989162a259f3ae3f32d6a749d308cd31fface3f" prot="public">
<name>XML_MODULE_LAZY</name>
<initializer>= 1</initializer>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
</enumvalue>
<enumvalue id="xmlmodule_8h_1a3da2abf53bc0cb57bcc3cc4fa8989162ae39d56a46be39a2cfc8becf7a7eaca28" prot="public">
<name>XML_MODULE_LOCAL</name>
<initializer>= 2</initializer>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
</enumvalue>
<briefdescription>
<para>enumeration of options that can be passed down to <ref refid="xmlmodule_8h_1ad1060e845e7984a1af144789b3ca2b67" kindref="member">xmlModuleOpen</ref> </para>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="xmlmodule.h" line="34" column="1" bodyfile="xmlmodule.h" bodystart="34" bodyend="37"/>
</memberdef>
</sectiondef>
<sectiondef kind="typedef">
<memberdef kind="typedef" id="xmlmodule_8h_1a55930515424d24517ec43731a4955a69" prot="public" static="no">
<type>struct _xmlModule</type>
<definition>typedef struct _xmlModule xmlModule</definition>
<argsstring></argsstring>
<name>xmlModule</name>
<briefdescription>
<para>A handle to a dynamically loaded module. </para>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="xmlmodule.h" line="28" column="25" bodyfile="xmlmodule.h" bodystart="28" bodyend="-1"/>
</memberdef>
<memberdef kind="typedef" id="xmlmodule_8h_1a6e5b590177251bd4196810e20985168f" prot="public" static="no">
<type><ref refid="xmlmodule_8h_1a55930515424d24517ec43731a4955a69" kindref="member">xmlModule</ref> *</type>
<definition>typedef xmlModule* xmlModulePtr</definition>
<argsstring></argsstring>
<name>xmlModulePtr</name>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="xmlmodule.h" line="29" column="19" bodyfile="xmlmodule.h" bodystart="29" bodyend="-1"/>
</memberdef>
</sectiondef>
<sectiondef kind="func">
<memberdef kind="function" id="xmlmodule_8h_1ad1060e845e7984a1af144789b3ca2b67" 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 *filename, int options)</argsstring>
<name>xmlModuleOpen</name>
<param>
<type>const char *</type>
<declname>filename</declname>
<defname>name</defname>
</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="xmlmodule.h" line="40" column="14" bodyfile="/builds/GNOME/libxml2/xmlmodule.c" bodystart="60" bodyend="79" declfile="xmlmodule.h" declline="40" declcolumn="14"/>
</memberdef>
<memberdef kind="function" id="xmlmodule_8h_1a907ca4f0afc57ba6a595bb45644372d5" 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 **result)</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>result</declname>
<defname>symbol</defname>
</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="xmlmodule.h" line="44" column="8" bodyfile="/builds/GNOME/libxml2/xmlmodule.c" bodystart="97" bodyend="110" declfile="xmlmodule.h" declline="44" declcolumn="8"/>
</memberdef>
<memberdef kind="function" id="xmlmodule_8h_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="xmlmodule.h" line="49" column="8" bodyfile="/builds/GNOME/libxml2/xmlmodule.c" bodystart="123" bodyend="137" declfile="xmlmodule.h" declline="49" declcolumn="8"/>
</memberdef>
<memberdef kind="function" id="xmlmodule_8h_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="xmlmodule.h" line="52" column="8" bodyfile="/builds/GNOME/libxml2/xmlmodule.c" bodystart="150" bodyend="159" declfile="xmlmodule.h" declline="52" declcolumn="8"/>
</memberdef>
</sectiondef>
<briefdescription>
<para>Dynamic module loading. </para>
</briefdescription>
<detaileddescription>
<para>API for dynamic module loading. Only used by old libxslt versions and subject to removal.</para>
<para><simplesect kind="copyright"><para>See Copyright for the status of this software.</para>
</simplesect>
<simplesect kind="author"><para>Joel W. Reed </para>
</simplesect>
</para>
</detaileddescription>
<location file="xmlmodule.h"/>
</compounddef>
</doxygen>
|
