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
|
<refentry id="xmlroff-FoXmlNode">
<refmeta>
<refentrytitle role="top_of_page" id="xmlroff-FoXmlNode.top_of_page">FoXmlNode</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>XMLROFF Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>FoXmlNode</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="xmlroff-FoXmlNode.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
#define <link linkend="FO-XML-NODE-ERROR:CAPS">FO_XML_NODE_ERROR</link>
<link linkend="GQuark">GQuark</link> <link linkend="fo-xml-node-error-quark">fo_xml_node_error_quark</link> (void);
enum <link linkend="FoXmlNodeError">FoXmlNodeError</link>;
<link linkend="FoXmlNode">FoXmlNode</link>;
<link linkend="FoXmlNode">FoXmlNode</link>* <link linkend="fo-xml-node-new">fo_xml_node_new</link> (void);
<link linkend="FoXmlNode">FoXmlNode</link>* <link linkend="fo-xml-node-ref">fo_xml_node_ref</link> (<link linkend="FoXmlNode">FoXmlNode</link> *fo_xml_node);
<link linkend="void">void</link> <link linkend="fo-xml-node-unref">fo_xml_node_unref</link> (<link linkend="FoXmlNode">FoXmlNode</link> *fo_xml_node);
</synopsis>
</refsynopsisdiv>
<refsect1 id="xmlroff-FoXmlNode.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="xmlroff-FoXmlNode.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="FO-XML-NODE-ERROR:CAPS" role="macro">
<title>FO_XML_NODE_ERROR</title>
<indexterm zone="FO-XML-NODE-ERROR:CAPS"><primary>FO_XML_NODE_ERROR</primary></indexterm><programlisting>#define FO_XML_NODE_ERROR fo_xml_node_error_quark ()
</programlisting>
<para>
</para></refsect2>
<refsect2 id="fo-xml-node-error-quark" role="function">
<title>fo_xml_node_error_quark ()</title>
<indexterm zone="fo-xml-node-error-quark"><primary>fo_xml_node_error_quark</primary></indexterm><programlisting><link linkend="GQuark">GQuark</link> fo_xml_node_error_quark (void);</programlisting>
<para>
Get the error quark for <link linkend="FoXmlNode"><type>FoXmlNode</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="FoXmlNode"><type>FoXmlNode</type></link> errors.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="FoXmlNodeError" role="enum">
<title>enum FoXmlNodeError</title>
<indexterm zone="FoXmlNodeError"><primary>FoXmlNodeError</primary></indexterm><programlisting>typedef enum
{
FO_XML_NODE_ERROR_FAILED,
FO_XML_NODE_ERROR_PARSE_FAILED,
FO_XML_NODE_ERROR_NO_FILENAME
} FoXmlNodeError;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="FoXmlNode" role="struct">
<title>FoXmlNode</title>
<indexterm zone="FoXmlNode"><primary>FoXmlNode</primary></indexterm><programlisting>typedef struct _FoXmlNode FoXmlNode;</programlisting>
<para>
</para></refsect2>
<refsect2 id="fo-xml-node-new" role="function">
<title>fo_xml_node_new ()</title>
<indexterm zone="fo-xml-node-new"><primary>fo_xml_node_new</primary></indexterm><programlisting><link linkend="FoXmlNode">FoXmlNode</link>* fo_xml_node_new (void);</programlisting>
<para>
Creates a new <link linkend="FoXmlNode"><type>FoXmlNode</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the newly created <link linkend="FoXmlNode"><type>FoXmlNode</type></link>. Use fo_xml_node_unref to free the
result.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-xml-node-ref" role="function">
<title>fo_xml_node_ref ()</title>
<indexterm zone="fo-xml-node-ref"><primary>fo_xml_node_ref</primary></indexterm><programlisting><link linkend="FoXmlNode">FoXmlNode</link>* fo_xml_node_ref (<link linkend="FoXmlNode">FoXmlNode</link> *fo_xml_node);</programlisting>
<para>
Make a copy of a <link linkend="FoXmlNode"><type>FoXmlNode</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>fo_xml_node</parameter> :</term>
<listitem><simpara> a <link linkend="FoXmlNode"><type>FoXmlNode</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a newly allocated <link linkend="FoXmlNode"><type>FoXmlNode</type></link>. This value
must be freed using <link linkend="fo-xml-node-unref"><function>fo_xml_node_unref()</function></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-xml-node-unref" role="function">
<title>fo_xml_node_unref ()</title>
<indexterm zone="fo-xml-node-unref"><primary>fo_xml_node_unref</primary></indexterm><programlisting><link linkend="void">void</link> fo_xml_node_unref (<link linkend="FoXmlNode">FoXmlNode</link> *fo_xml_node);</programlisting>
<para>
Unref and possibly free a <link linkend="FoXmlNode"><type>FoXmlNode</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>fo_xml_node</parameter> :</term>
<listitem><simpara> <link linkend="FoXmlNode"><type>FoXmlNode</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
