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
|
<refentry id="xmlroff-FoXmlDoc">
<refmeta>
<refentrytitle role="top_of_page" id="xmlroff-FoXmlDoc.top_of_page">FoXmlDoc</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>XMLROFF Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>FoXmlDoc</refname>
<refpurpose>libxml2 xmlDoc document</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="xmlroff-FoXmlDoc.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
#define <link linkend="FO-XML-DOC-ERROR:CAPS">FO_XML_DOC_ERROR</link>
<link linkend="GQuark">GQuark</link> <link linkend="fo-xml-doc-error-quark">fo_xml_doc_error_quark</link> (void);
enum <link linkend="FoXmlDocError">FoXmlDocError</link>;
<link linkend="FoXmlDoc">FoXmlDoc</link>;
const <link linkend="LibfoVersionInfo">LibfoVersionInfo</link>* <link linkend="fo-xml-doc-version-info">fo_xml_doc_version_info</link> (void);
<link linkend="FoXmlDoc">FoXmlDoc</link>* <link linkend="fo-xml-doc-new-from-filename">fo_xml_doc_new_from_filename</link> (const <link linkend="gchar">gchar</link> *filename,
<link linkend="FoLibfoContext">FoLibfoContext</link> *libfo_context,
<link linkend="GError">GError</link> **error);
<link linkend="FoXmlDoc">FoXmlDoc</link>* <link linkend="fo-xml-doc-new-from-memory">fo_xml_doc_new_from_memory</link> (const <link linkend="gchar">gchar</link> *buffer,
<link linkend="gint">gint</link> size,
const <link linkend="gchar">gchar</link> *URL,
const <link linkend="gchar">gchar</link> *encoding,
<link linkend="FoLibfoContext">FoLibfoContext</link> *libfo_context,
<link linkend="GError">GError</link> **error);
<link linkend="FoXmlDoc">FoXmlDoc</link>* <link linkend="fo-xml-doc-new-from-string">fo_xml_doc_new_from_string</link> (const <link linkend="gchar">gchar</link> *curr,
const <link linkend="gchar">gchar</link> *URL,
const <link linkend="gchar">gchar</link> *encoding,
<link linkend="FoLibfoContext">FoLibfoContext</link> *libfo_context,
<link linkend="GError">GError</link> **error);
<link linkend="FoXmlDoc">FoXmlDoc</link>* <link linkend="fo-xml-doc-ref">fo_xml_doc_ref</link> (<link linkend="FoXmlDoc">FoXmlDoc</link> *fo_xml_doc);
<link linkend="void">void</link> <link linkend="fo-xml-doc-unref">fo_xml_doc_unref</link> (<link linkend="FoXmlDoc">FoXmlDoc</link> *fo_xml_doc);
<link linkend="gchar">gchar</link>* <link linkend="fo-xml-doc-get-base">fo_xml_doc_get_base</link> (<link linkend="FoXmlDoc">FoXmlDoc</link> *fo_xml_doc);
<link linkend="void">void</link> <link linkend="fo-xml-doc-set-base">fo_xml_doc_set_base</link> (<link linkend="FoXmlDoc">FoXmlDoc</link> *fo_xml_doc,
const <link linkend="gchar">gchar</link> *URL);
</synopsis>
</refsynopsisdiv>
<refsect1 id="xmlroff-FoXmlDoc.description" role="desc">
<title role="desc.title">Description</title>
<para>
Boxed object type for libxml2 xmlDoc document.</para>
<para>
</para>
</refsect1>
<refsect1 id="xmlroff-FoXmlDoc.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="FO-XML-DOC-ERROR:CAPS" role="macro">
<title>FO_XML_DOC_ERROR</title>
<indexterm zone="FO-XML-DOC-ERROR:CAPS"><primary>FO_XML_DOC_ERROR</primary></indexterm><programlisting>#define FO_XML_DOC_ERROR fo_xml_doc_error_quark ()
</programlisting>
<para>
</para></refsect2>
<refsect2 id="fo-xml-doc-error-quark" role="function">
<title>fo_xml_doc_error_quark ()</title>
<indexterm zone="fo-xml-doc-error-quark"><primary>fo_xml_doc_error_quark</primary></indexterm><programlisting><link linkend="GQuark">GQuark</link> fo_xml_doc_error_quark (void);</programlisting>
<para>
Get the error quark for <link linkend="FoXmlDoc"><type>FoXmlDoc</type></link>.
</para>
<para>
If the quark does not yet exist, create it.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Quark associated with <link linkend="FoXmlDoc"><type>FoXmlDoc</type></link> errors.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="FoXmlDocError" role="enum">
<title>enum FoXmlDocError</title>
<indexterm zone="FoXmlDocError"><primary>FoXmlDocError</primary></indexterm><programlisting>typedef enum
{
FO_XML_DOC_ERROR_FAILED,
FO_XML_DOC_ERROR_FILENAME_PARSE_FAILED,
FO_XML_DOC_ERROR_MEMORY_PARSE_FAILED,
FO_XML_DOC_ERROR_NO_FILENAME
} FoXmlDocError;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="FoXmlDoc" role="struct">
<title>FoXmlDoc</title>
<indexterm zone="FoXmlDoc"><primary>FoXmlDoc</primary></indexterm><programlisting>typedef struct _FoXmlDoc FoXmlDoc;</programlisting>
<para>
</para></refsect2>
<refsect2 id="fo-xml-doc-version-info" role="function">
<title>fo_xml_doc_version_info ()</title>
<indexterm zone="fo-xml-doc-version-info"><primary>fo_xml_doc_version_info</primary></indexterm><programlisting>const <link linkend="LibfoVersionInfo">LibfoVersionInfo</link>* fo_xml_doc_version_info (void);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-xml-doc-new-from-filename" role="function">
<title>fo_xml_doc_new_from_filename ()</title>
<indexterm zone="fo-xml-doc-new-from-filename"><primary>fo_xml_doc_new_from_filename</primary></indexterm><programlisting><link linkend="FoXmlDoc">FoXmlDoc</link>* fo_xml_doc_new_from_filename (const <link linkend="gchar">gchar</link> *filename,
<link linkend="FoLibfoContext">FoLibfoContext</link> *libfo_context,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
Creates a new <link linkend="FoXmlDoc"><type>FoXmlDoc</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>filename</parameter> :</term>
<listitem><simpara> File or URL from which to create an <link linkend="FoXmlDoc"><type>FoXmlDoc</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>libfo_context</parameter> :</term>
<listitem><simpara> <link linkend="FoLibfoContext"><type>FoLibfoContext</type></link> with parameters affecting parsing.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> Indication of any error that occurred.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the newly created <link linkend="FoXmlDoc"><type>FoXmlDoc</type></link>. Use fo_xml_doc_unref to free the
result.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-xml-doc-new-from-memory" role="function">
<title>fo_xml_doc_new_from_memory ()</title>
<indexterm zone="fo-xml-doc-new-from-memory"><primary>fo_xml_doc_new_from_memory</primary></indexterm><programlisting><link linkend="FoXmlDoc">FoXmlDoc</link>* fo_xml_doc_new_from_memory (const <link linkend="gchar">gchar</link> *buffer,
<link linkend="gint">gint</link> size,
const <link linkend="gchar">gchar</link> *URL,
const <link linkend="gchar">gchar</link> *encoding,
<link linkend="FoLibfoContext">FoLibfoContext</link> *libfo_context,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
Creates a new <link linkend="FoXmlDoc"><type>FoXmlDoc</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>buffer</parameter> :</term>
<listitem><simpara> Pointer to a char array.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>size</parameter> :</term>
<listitem><simpara> Size of the array.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>URL</parameter> :</term>
<listitem><simpara> Base URL to use for the document.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>encoding</parameter> :</term>
<listitem><simpara> The encoding of the document, or NULL.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>libfo_context</parameter> :</term>
<listitem><simpara> <link linkend="FoLibfoContext"><type>FoLibfoContext</type></link> with parameters affecting parsing.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> Indication of any error that occurred.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the newly created <link linkend="FoXmlDoc"><type>FoXmlDoc</type></link>. Use <link linkend="fo-xml-doc-unref"><type>fo_xml_doc_unref</type></link> to free the
result.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-xml-doc-new-from-string" role="function">
<title>fo_xml_doc_new_from_string ()</title>
<indexterm zone="fo-xml-doc-new-from-string"><primary>fo_xml_doc_new_from_string</primary></indexterm><programlisting><link linkend="FoXmlDoc">FoXmlDoc</link>* fo_xml_doc_new_from_string (const <link linkend="gchar">gchar</link> *curr,
const <link linkend="gchar">gchar</link> *URL,
const <link linkend="gchar">gchar</link> *encoding,
<link linkend="FoLibfoContext">FoLibfoContext</link> *libfo_context,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
Creates a new <link linkend="FoXmlDoc"><type>FoXmlDoc</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>curr</parameter> :</term>
<listitem><simpara> Pointer to a zero-terminated string.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>URL</parameter> :</term>
<listitem><simpara> Base URL to use for the document.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>encoding</parameter> :</term>
<listitem><simpara> The encoding of the document, or NULL.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>libfo_context</parameter> :</term>
<listitem><simpara> <link linkend="FoLibfoContext"><type>FoLibfoContext</type></link> with parameters affecting parsing.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> Indication of any error that occurred.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the newly created <link linkend="FoXmlDoc"><type>FoXmlDoc</type></link>. Use <link linkend="fo-xml-doc-unref"><type>fo_xml_doc_unref</type></link> to free the
result.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-xml-doc-ref" role="function">
<title>fo_xml_doc_ref ()</title>
<indexterm zone="fo-xml-doc-ref"><primary>fo_xml_doc_ref</primary></indexterm><programlisting><link linkend="FoXmlDoc">FoXmlDoc</link>* fo_xml_doc_ref (<link linkend="FoXmlDoc">FoXmlDoc</link> *fo_xml_doc);</programlisting>
<para>
Make a copy of a <link linkend="FoXmlDoc"><type>FoXmlDoc</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>fo_xml_doc</parameter> :</term>
<listitem><simpara> a <link linkend="FoXmlDoc"><type>FoXmlDoc</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a newly allocated <link linkend="FoXmlDoc"><type>FoXmlDoc</type></link>. This value
must be freed using #<link linkend="fo-xml-doc-unref"><function>fo_xml_doc_unref()</function></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-xml-doc-unref" role="function">
<title>fo_xml_doc_unref ()</title>
<indexterm zone="fo-xml-doc-unref"><primary>fo_xml_doc_unref</primary></indexterm><programlisting><link linkend="void">void</link> fo_xml_doc_unref (<link linkend="FoXmlDoc">FoXmlDoc</link> *fo_xml_doc);</programlisting>
<para>
Unref and possibly free a <link linkend="FoXmlDoc"><type>FoXmlDoc</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>fo_xml_doc</parameter> :</term>
<listitem><simpara> <link linkend="FoXmlDoc"><type>FoXmlDoc</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-xml-doc-get-base" role="function">
<title>fo_xml_doc_get_base ()</title>
<indexterm zone="fo-xml-doc-get-base"><primary>fo_xml_doc_get_base</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* fo_xml_doc_get_base (<link linkend="FoXmlDoc">FoXmlDoc</link> *fo_xml_doc);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>fo_xml_doc</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-xml-doc-set-base" role="function">
<title>fo_xml_doc_set_base ()</title>
<indexterm zone="fo-xml-doc-set-base"><primary>fo_xml_doc_set_base</primary></indexterm><programlisting><link linkend="void">void</link> fo_xml_doc_set_base (<link linkend="FoXmlDoc">FoXmlDoc</link> *fo_xml_doc,
const <link linkend="gchar">gchar</link> *URL);</programlisting>
<para>
Sets the base URL of <parameter>fo_xml_doc</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>fo_xml_doc</parameter> :</term>
<listitem><simpara> <link linkend="FoXmlDoc"><type>FoXmlDoc</type></link> for which to set base
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>URL</parameter> :</term>
<listitem><simpara> New xml:base URL
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
