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
|
<refentry id="FoHashTable">
<refmeta>
<refentrytitle role="top_of_page" id="FoHashTable.top_of_page">FoHashTable</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>XMLROFF Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>FoHashTable</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="FoHashTable.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="FoHashTable-struct">FoHashTable</link>;
<link linkend="FoHashTableClass">FoHashTableClass</link>;
#define <link linkend="FO-HASH-TABLE-ERROR:CAPS">FO_HASH_TABLE_ERROR</link>
<link linkend="GQuark">GQuark</link> <link linkend="fo-hash-table-error-quark">fo_hash_table_error_quark</link> (void);
<link linkend="FoHashTable">FoHashTable</link>* <link linkend="fo-hash-table-new">fo_hash_table_new</link> (void);
<link linkend="void">void</link> <link linkend="fo-hash-table-insert">fo_hash_table_insert</link> (<link linkend="FoHashTable">FoHashTable</link> *fo_hash_table,
<link linkend="FoObject">FoObject</link> *key,
<link linkend="FoObject">FoObject</link> *value,
<link linkend="GError">GError</link> **error);
<link linkend="void">void</link> <link linkend="fo-hash-table-replace">fo_hash_table_replace</link> (<link linkend="FoHashTable">FoHashTable</link> *fo_hash_table,
<link linkend="FoObject">FoObject</link> *key,
<link linkend="FoObject">FoObject</link> *value,
<link linkend="GError">GError</link> **error);
<link linkend="gboolean">gboolean</link> <link linkend="fo-hash-table-remove">fo_hash_table_remove</link> (<link linkend="FoHashTable">FoHashTable</link> *fo_hash_table,
<link linkend="FoObject">FoObject</link> *key,
<link linkend="GError">GError</link> **error);
<link linkend="FoObject">FoObject</link>* <link linkend="fo-hash-table-lookup">fo_hash_table_lookup</link> (<link linkend="FoHashTable">FoHashTable</link> *fo_hash_table,
<link linkend="FoObject">FoObject</link> *key,
<link linkend="GError">GError</link> **error);
<link linkend="guint">guint</link> <link linkend="fo-hash-table-size">fo_hash_table_size</link> (<link linkend="FoHashTable">FoHashTable</link> *fo_hash_table);
</synopsis>
</refsynopsisdiv>
<refsect1 id="FoHashTable.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="FoObject">FoObject</link>
+----FoHashTable
</synopsis>
</refsect1>
<refsect1 id="FoHashTable.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="FoHashTable.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="FoHashTable-struct" role="struct">
<title>FoHashTable</title>
<indexterm zone="FoHashTable-struct"><primary>FoHashTable</primary></indexterm><programlisting>typedef struct _FoHashTable FoHashTable;</programlisting>
<para>
</para></refsect2>
<refsect2 id="FoHashTableClass" role="struct">
<title>FoHashTableClass</title>
<indexterm zone="FoHashTableClass"><primary>FoHashTableClass</primary></indexterm><programlisting>typedef struct _FoHashTableClass FoHashTableClass;</programlisting>
<para>
</para></refsect2>
<refsect2 id="FO-HASH-TABLE-ERROR:CAPS" role="macro">
<title>FO_HASH_TABLE_ERROR</title>
<indexterm zone="FO-HASH-TABLE-ERROR:CAPS"><primary>FO_HASH_TABLE_ERROR</primary></indexterm><programlisting>#define FO_HASH_TABLE_ERROR fo_hash_table_error_quark ()
</programlisting>
<para>
</para></refsect2>
<refsect2 id="fo-hash-table-error-quark" role="function">
<title>fo_hash_table_error_quark ()</title>
<indexterm zone="fo-hash-table-error-quark"><primary>fo_hash_table_error_quark</primary></indexterm><programlisting><link linkend="GQuark">GQuark</link> fo_hash_table_error_quark (void);</programlisting>
<para>
Get the error quark for <link linkend="FoHashTable"><type>FoHashTable</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="FoHashTable"><type>FoHashTable</type></link> errors.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-hash-table-new" role="function">
<title>fo_hash_table_new ()</title>
<indexterm zone="fo-hash-table-new"><primary>fo_hash_table_new</primary></indexterm><programlisting><link linkend="FoHashTable">FoHashTable</link>* fo_hash_table_new (void);</programlisting>
<para>
Creates a new <link linkend="FoHashTable"><type>FoHashTable</type></link> initialized to default value.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the new <link linkend="FoHashTable"><type>FoHashTable</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-hash-table-insert" role="function">
<title>fo_hash_table_insert ()</title>
<indexterm zone="fo-hash-table-insert"><primary>fo_hash_table_insert</primary></indexterm><programlisting><link linkend="void">void</link> fo_hash_table_insert (<link linkend="FoHashTable">FoHashTable</link> *fo_hash_table,
<link linkend="FoObject">FoObject</link> *key,
<link linkend="FoObject">FoObject</link> *value,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
Inserts <parameter>value</parameter> as the value corresponding to <parameter>key</parameter> in
<parameter>fo_hash_table</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>fo_hash_table</parameter> :</term>
<listitem><simpara> <link linkend="FoHashTable"><type>FoHashTable</type></link> in which to insert.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>key</parameter> :</term>
<listitem><simpara> Key at which to insert.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter> :</term>
<listitem><simpara> Value to insert.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> <link linkend="GError"><type>GError</type></link> with information about error that occurred.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-hash-table-replace" role="function">
<title>fo_hash_table_replace ()</title>
<indexterm zone="fo-hash-table-replace"><primary>fo_hash_table_replace</primary></indexterm><programlisting><link linkend="void">void</link> fo_hash_table_replace (<link linkend="FoHashTable">FoHashTable</link> *fo_hash_table,
<link linkend="FoObject">FoObject</link> *key,
<link linkend="FoObject">FoObject</link> *value,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
Replaces the key-value pair in <parameter>fo_hash_table</parameter> that has a key
matching <parameter>key</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>fo_hash_table</parameter> :</term>
<listitem><simpara> <link linkend="FoHashTable"><type>FoHashTable</type></link> in which to replace.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>key</parameter> :</term>
<listitem><simpara> Key of key-value pair to replace.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter> :</term>
<listitem><simpara> New value.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> <link linkend="GError"><type>GError</type></link> with information about error that occurred.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-hash-table-remove" role="function">
<title>fo_hash_table_remove ()</title>
<indexterm zone="fo-hash-table-remove"><primary>fo_hash_table_remove</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> fo_hash_table_remove (<link linkend="FoHashTable">FoHashTable</link> *fo_hash_table,
<link linkend="FoObject">FoObject</link> *key,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
Removes the key-value pair with key matching <parameter>key</parameter> from
<parameter>fo_hash_table</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>fo_hash_table</parameter> :</term>
<listitem><simpara> <link linkend="FoHashTable"><type>FoHashTable</type></link> from which to remove a key-value pair.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>key</parameter> :</term>
<listitem><simpara> Key of pair to remove.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> <link linkend="GError"><type>GError</type></link> with information about error that occurred.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> is successful.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-hash-table-lookup" role="function">
<title>fo_hash_table_lookup ()</title>
<indexterm zone="fo-hash-table-lookup"><primary>fo_hash_table_lookup</primary></indexterm><programlisting><link linkend="FoObject">FoObject</link>* fo_hash_table_lookup (<link linkend="FoHashTable">FoHashTable</link> *fo_hash_table,
<link linkend="FoObject">FoObject</link> *key,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
Gets the value associated with <parameter>key</parameter> in <parameter>fo_hash_table</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>fo_hash_table</parameter> :</term>
<listitem><simpara> <link linkend="FoHashTable"><type>FoHashTable</type></link> in which to look.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>key</parameter> :</term>
<listitem><simpara> Key value against which to compare.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> <link linkend="GError"><type>GError</type></link> with information about error that occurred.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The value, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if no matching key.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-hash-table-size" role="function">
<title>fo_hash_table_size ()</title>
<indexterm zone="fo-hash-table-size"><primary>fo_hash_table_size</primary></indexterm><programlisting><link linkend="guint">guint</link> fo_hash_table_size (<link linkend="FoHashTable">FoHashTable</link> *fo_hash_table);</programlisting>
<para>
Gets the number of key-value pairs in <parameter>fo_hash_table</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>fo_hash_table</parameter> :</term>
<listitem><simpara> <link linkend="FoHashTable"><type>FoHashTable</type></link> for which to get size.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Number of key-value pairs.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
