← Back to branch summary

~ubuntu-branches/debian/squeeze/glib2.0/squeeze

« back to all changes in this revision

Viewing changes to docs/reference/glib/xml/relations.xml

  • Committer: Bazaar Package Importer
  • Author(s): Gustavo Noronha Silva
  • Date: 2009-02-15 13:00:43 UTC
  • mfrom: (1.3.1 upstream) (69.1.10 intrepid)
  • Revision ID: james.westby@ubuntu.com-20090215130043-q47fbt3owmt42m2f
Tags: 2.18.4-2
* Release to unstable
* debian/rules:
- bump SHVER, since we are already forcing a 2.18.0 dependecy on the
  symbols introduced in the development versions
* debian/control.in:
- added Homepage and Vcs-* control fields

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/glib/xml/relations.xml
1
1
<refentry id="glib-Relations-and-Tuples">
2
2
<refmeta>
3
 
<refentrytitle role="top_of_page">Relations and Tuples</refentrytitle>
 
3
<refentrytitle role="top_of_page" id="glib-Relations-and-Tuples.top_of_page">Relations and Tuples</refentrytitle>
4
4
<manvolnum>3</manvolnum>
5
5
<refmiscinfo>GLIB Library</refmiscinfo>
6
6
</refmeta>
8
8
<refnamediv>
9
9
<refname>Relations and Tuples</refname>
10
10
<refpurpose>tables of data which can be indexed on any number of fields</refpurpose>
11
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
12
11
</refnamediv>
13
12
 
14
 
<refsynopsisdiv role="synopsis">
 
13
<refsynopsisdiv id="glib-Relations-and-Tuples.synopsis" role="synopsis">
15
14
<title role="synopsis.title">Synopsis</title>
16
15
 
17
16
<synopsis>
18
17
 
19
18
#include &lt;glib.h&gt;
20
19
 
21
 
 
22
20
                    <link linkend="GRelation">GRelation</link>;
23
21
<link linkend="GRelation">GRelation</link>*          <link linkend="g-relation-new">g_relation_new</link>                      (<link linkend="gint">gint</link> fields);
24
22
<link linkend="void">void</link>                <link linkend="g-relation-index">g_relation_index</link>                    (<link linkend="GRelation">GRelation</link> *relation,
58
56
 
59
57
 
60
58
 
61
 
<refsect1 role="desc">
 
59
<refsect1 id="glib-Relations-and-Tuples.description" role="desc">
62
60
<title role="desc.title">Description</title>
63
61
<para>
64
62
A <link linkend="GRelation"><type>GRelation</type></link> is a table of data which can be indexed on any number of fields,
107
105
</para>
108
106
</refsect1>
109
107
 
110
 
<refsect1 role="details">
 
108
<refsect1 id="glib-Relations-and-Tuples.details" role="details">
111
109
<title role="details.title">Details</title>
112
 
<refsect2>
113
 
<title><anchor id="GRelation" role="struct"/>GRelation</title>
114
 
<indexterm><primary>GRelation</primary></indexterm><programlisting>typedef struct _GRelation GRelation;</programlisting>
 
110
<refsect2 id="GRelation" role="struct">
 
111
<title>GRelation</title>
 
112
<indexterm zone="GRelation"><primary sortas="GRelation">GRelation</primary></indexterm><programlisting>typedef struct _GRelation GRelation;</programlisting>
115
113
<para>
116
114
The <link linkend="GRelation"><type>GRelation</type></link> struct is an opaque data structure to represent a
117
115
<link linkend="glib-Relations-and-Tuples">Relation</link>.
118
116
It should only be accessed via the following functions.
119
117
</para></refsect2>
120
 
<refsect2>
121
 
<title><anchor id="g-relation-new" role="function"/>g_relation_new ()</title>
122
 
<indexterm><primary>g_relation_new</primary></indexterm><programlisting><link linkend="GRelation">GRelation</link>*          g_relation_new                      (<link linkend="gint">gint</link> fields);</programlisting>
 
118
<refsect2 id="g-relation-new" role="function">
 
119
<title>g_relation_new ()</title>
 
120
<indexterm zone="g-relation-new"><primary sortas="g_relation_new">g_relation_new</primary></indexterm><programlisting><link linkend="GRelation">GRelation</link>*          g_relation_new                      (<link linkend="gint">gint</link> fields);</programlisting>
123
121
<para>
124
122
Creates a new <link linkend="GRelation"><type>GRelation</type></link> with the given number of fields.
125
123
Note that currently the number of fields must be 2.
126
124
</para><variablelist role="params">
127
 
<varlistentry><term><parameter>fields</parameter>&nbsp;:</term>
 
125
<varlistentry><term><parameter>fields</parameter>&#160;:</term>
128
126
<listitem><simpara>the number of fields.
129
127
</simpara></listitem></varlistentry>
130
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>a new <link linkend="GRelation"><type>GRelation</type></link>.
131
 
 
132
 
 
 
128
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>a new <link linkend="GRelation"><type>GRelation</type></link>.
133
129
</simpara></listitem></varlistentry>
134
130
</variablelist></refsect2>
135
 
<refsect2>
136
 
<title><anchor id="g-relation-index" role="function"/>g_relation_index ()</title>
137
 
<indexterm><primary>g_relation_index</primary></indexterm><programlisting><link linkend="void">void</link>                g_relation_index                    (<link linkend="GRelation">GRelation</link> *relation,
 
131
<refsect2 id="g-relation-index" role="function">
 
132
<title>g_relation_index ()</title>
 
133
<indexterm zone="g-relation-index"><primary sortas="g_relation_index">g_relation_index</primary></indexterm><programlisting><link linkend="void">void</link>                g_relation_index                    (<link linkend="GRelation">GRelation</link> *relation,
138
134
                                                         <link linkend="gint">gint</link> field,
139
135
                                                         <link linkend="GHashFunc">GHashFunc</link> hash_func,
140
136
                                                         <link linkend="GEqualFunc">GEqualFunc</link> key_equal_func);</programlisting>
142
138
Creates an index on the given field.
143
139
Note that this must be called before any records are added to the <link linkend="GRelation"><type>GRelation</type></link>.
144
140
</para><variablelist role="params">
145
 
<varlistentry><term><parameter>relation</parameter>&nbsp;:</term>
 
141
<varlistentry><term><parameter>relation</parameter>&#160;:</term>
146
142
<listitem><simpara>a <link linkend="GRelation"><type>GRelation</type></link>.
147
143
</simpara></listitem></varlistentry>
148
 
<varlistentry><term><parameter>field</parameter>&nbsp;:</term>
 
144
<varlistentry><term><parameter>field</parameter>&#160;:</term>
149
145
<listitem><simpara>the field to index, counting from 0.
150
146
</simpara></listitem></varlistentry>
151
 
<varlistentry><term><parameter>hash_func</parameter>&nbsp;:</term>
 
147
<varlistentry><term><parameter>hash_func</parameter>&#160;:</term>
152
148
<listitem><simpara>a function to produce a hash value from the field data.
153
149
</simpara></listitem></varlistentry>
154
 
<varlistentry><term><parameter>key_equal_func</parameter>&nbsp;:</term>
 
150
<varlistentry><term><parameter>key_equal_func</parameter>&#160;:</term>
155
151
<listitem><simpara>a function to compare two values of the given field.
156
 
 
157
 
 
158
152
</simpara></listitem></varlistentry>
159
153
</variablelist></refsect2>
160
 
<refsect2>
161
 
<title><anchor id="g-relation-insert" role="function"/>g_relation_insert ()</title>
162
 
<indexterm><primary>g_relation_insert</primary></indexterm><programlisting><link linkend="void">void</link>                g_relation_insert                   (<link linkend="GRelation">GRelation</link> *relation,
 
154
<refsect2 id="g-relation-insert" role="function">
 
155
<title>g_relation_insert ()</title>
 
156
<indexterm zone="g-relation-insert"><primary sortas="g_relation_insert">g_relation_insert</primary></indexterm><programlisting><link linkend="void">void</link>                g_relation_insert                   (<link linkend="GRelation">GRelation</link> *relation,
163
157
                                                         ...);</programlisting>
164
158
<para>
165
159
Inserts a record into a <link linkend="GRelation"><type>GRelation</type></link>.
166
160
</para><variablelist role="params">
167
 
<varlistentry><term><parameter>relation</parameter>&nbsp;:</term>
 
161
<varlistentry><term><parameter>relation</parameter>&#160;:</term>
168
162
<listitem><simpara>a <link linkend="GRelation"><type>GRelation</type></link>.
169
163
</simpara></listitem></varlistentry>
170
 
<varlistentry><term><parameter>...</parameter>&nbsp;:</term>
 
164
<varlistentry><term><parameter>...</parameter>&#160;:</term>
171
165
<listitem><simpara>the fields of the record to add. These must match the number of
172
166
fields in the <link linkend="GRelation"><type>GRelation</type></link>, and of type <link linkend="gpointer"><type>gpointer</type></link> or <link linkend="gconstpointer"><type>gconstpointer</type></link>.
173
 
 
174
 
 
175
167
</simpara></listitem></varlistentry>
176
168
</variablelist></refsect2>
177
 
<refsect2>
178
 
<title><anchor id="g-relation-exists" role="function"/>g_relation_exists ()</title>
179
 
<indexterm><primary>g_relation_exists</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_relation_exists                   (<link linkend="GRelation">GRelation</link> *relation,
 
169
<refsect2 id="g-relation-exists" role="function">
 
170
<title>g_relation_exists ()</title>
 
171
<indexterm zone="g-relation-exists"><primary sortas="g_relation_exists">g_relation_exists</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_relation_exists                   (<link linkend="GRelation">GRelation</link> *relation,
180
172
                                                         ...);</programlisting>
181
173
<para>
182
 
Returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if a record with the given values exists in a <link linkend="GRelation"><type>GRelation</type></link>.
 
174
Returns <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if a record with the given values exists in a <link linkend="GRelation"><type>GRelation</type></link>.
183
175
Note that the values are compared directly, so that, for example, two
184
176
copies of the same string will not match.
185
177
</para><variablelist role="params">
186
 
<varlistentry><term><parameter>relation</parameter>&nbsp;:</term>
 
178
<varlistentry><term><parameter>relation</parameter>&#160;:</term>
187
179
<listitem><simpara>a <link linkend="GRelation"><type>GRelation</type></link>.
188
180
</simpara></listitem></varlistentry>
189
 
<varlistentry><term><parameter>...</parameter>&nbsp;:</term>
 
181
<varlistentry><term><parameter>...</parameter>&#160;:</term>
190
182
<listitem><simpara>the fields of the record to compare. The number must match the
191
183
number of fields in the <link linkend="GRelation"><type>GRelation</type></link>.
192
184
</simpara></listitem></varlistentry>
193
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara><link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if a record matches.
194
 
 
195
 
 
 
185
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>%TRUE if a record matches.
196
186
</simpara></listitem></varlistentry>
197
187
</variablelist></refsect2>
198
 
<refsect2>
199
 
<title><anchor id="g-relation-count" role="function"/>g_relation_count ()</title>
200
 
<indexterm><primary>g_relation_count</primary></indexterm><programlisting><link linkend="gint">gint</link>                g_relation_count                    (<link linkend="GRelation">GRelation</link> *relation,
 
188
<refsect2 id="g-relation-count" role="function">
 
189
<title>g_relation_count ()</title>
 
190
<indexterm zone="g-relation-count"><primary sortas="g_relation_count">g_relation_count</primary></indexterm><programlisting><link linkend="gint">gint</link>                g_relation_count                    (<link linkend="GRelation">GRelation</link> *relation,
201
191
                                                         <link linkend="gconstpointer">gconstpointer</link> key,
202
192
                                                         <link linkend="gint">gint</link> field);</programlisting>
203
193
<para>
204
194
Returns the number of tuples in a <link linkend="GRelation"><type>GRelation</type></link> that have the given value
205
195
in the given field.
206
196
</para><variablelist role="params">
207
 
<varlistentry><term><parameter>relation</parameter>&nbsp;:</term>
 
197
<varlistentry><term><parameter>relation</parameter>&#160;:</term>
208
198
<listitem><simpara>a <link linkend="GRelation"><type>GRelation</type></link>.
209
199
</simpara></listitem></varlistentry>
210
 
<varlistentry><term><parameter>key</parameter>&nbsp;:</term>
 
200
<varlistentry><term><parameter>key</parameter>&#160;:</term>
211
201
<listitem><simpara>the value to compare with.
212
202
</simpara></listitem></varlistentry>
213
 
<varlistentry><term><parameter>field</parameter>&nbsp;:</term>
 
203
<varlistentry><term><parameter>field</parameter>&#160;:</term>
214
204
<listitem><simpara>the field of each record to match.
215
205
</simpara></listitem></varlistentry>
216
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>the number of matches.
217
 
 
218
 
 
 
206
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>the number of matches.
219
207
</simpara></listitem></varlistentry>
220
208
</variablelist></refsect2>
221
 
<refsect2>
222
 
<title><anchor id="g-relation-select" role="function"/>g_relation_select ()</title>
223
 
<indexterm><primary>g_relation_select</primary></indexterm><programlisting><link linkend="GTuples">GTuples</link>*            g_relation_select                   (<link linkend="GRelation">GRelation</link> *relation,
 
209
<refsect2 id="g-relation-select" role="function">
 
210
<title>g_relation_select ()</title>
 
211
<indexterm zone="g-relation-select"><primary sortas="g_relation_select">g_relation_select</primary></indexterm><programlisting><link linkend="GTuples">GTuples</link>*            g_relation_select                   (<link linkend="GRelation">GRelation</link> *relation,
224
212
                                                         <link linkend="gconstpointer">gconstpointer</link> key,
225
213
                                                         <link linkend="gint">gint</link> field);</programlisting>
226
214
<para>
228
216
Use <link linkend="g-tuples-index"><function>g_tuples_index()</function></link> to access the returned records.
229
217
The returned records should be freed with <link linkend="g-tuples-destroy"><function>g_tuples_destroy()</function></link>.
230
218
</para><variablelist role="params">
231
 
<varlistentry><term><parameter>relation</parameter>&nbsp;:</term>
 
219
<varlistentry><term><parameter>relation</parameter>&#160;:</term>
232
220
<listitem><simpara>a <link linkend="GRelation"><type>GRelation</type></link>.
233
221
</simpara></listitem></varlistentry>
234
 
<varlistentry><term><parameter>key</parameter>&nbsp;:</term>
 
222
<varlistentry><term><parameter>key</parameter>&#160;:</term>
235
223
<listitem><simpara>the value to compare with.
236
224
</simpara></listitem></varlistentry>
237
 
<varlistentry><term><parameter>field</parameter>&nbsp;:</term>
 
225
<varlistentry><term><parameter>field</parameter>&#160;:</term>
238
226
<listitem><simpara>the field of each record to match.
239
227
</simpara></listitem></varlistentry>
240
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>the records (tuples) that matched.
241
 
 
242
 
 
 
228
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>the records (tuples) that matched.
243
229
</simpara></listitem></varlistentry>
244
230
</variablelist></refsect2>
245
 
<refsect2>
246
 
<title><anchor id="g-relation-delete" role="function"/>g_relation_delete ()</title>
247
 
<indexterm><primary>g_relation_delete</primary></indexterm><programlisting><link linkend="gint">gint</link>                g_relation_delete                   (<link linkend="GRelation">GRelation</link> *relation,
 
231
<refsect2 id="g-relation-delete" role="function">
 
232
<title>g_relation_delete ()</title>
 
233
<indexterm zone="g-relation-delete"><primary sortas="g_relation_delete">g_relation_delete</primary></indexterm><programlisting><link linkend="gint">gint</link>                g_relation_delete                   (<link linkend="GRelation">GRelation</link> *relation,
248
234
                                                         <link linkend="gconstpointer">gconstpointer</link> key,
249
235
                                                         <link linkend="gint">gint</link> field);</programlisting>
250
236
<para>
251
237
Deletes any records from a <link linkend="GRelation"><type>GRelation</type></link> that have the given key value in
252
238
the given field.
253
239
</para><variablelist role="params">
254
 
<varlistentry><term><parameter>relation</parameter>&nbsp;:</term>
 
240
<varlistentry><term><parameter>relation</parameter>&#160;:</term>
255
241
<listitem><simpara>a <link linkend="GRelation"><type>GRelation</type></link>.
256
242
</simpara></listitem></varlistentry>
257
 
<varlistentry><term><parameter>key</parameter>&nbsp;:</term>
 
243
<varlistentry><term><parameter>key</parameter>&#160;:</term>
258
244
<listitem><simpara>the value to compare with.
259
245
</simpara></listitem></varlistentry>
260
 
<varlistentry><term><parameter>field</parameter>&nbsp;:</term>
 
246
<varlistentry><term><parameter>field</parameter>&#160;:</term>
261
247
<listitem><simpara>the field of each record to match.
262
248
</simpara></listitem></varlistentry>
263
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>the number of records deleted.
264
 
 
265
 
 
 
249
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>the number of records deleted.
266
250
</simpara></listitem></varlistentry>
267
251
</variablelist></refsect2>
268
 
<refsect2>
269
 
<title><anchor id="g-relation-destroy" role="function"/>g_relation_destroy ()</title>
270
 
<indexterm><primary>g_relation_destroy</primary></indexterm><programlisting><link linkend="void">void</link>                g_relation_destroy                  (<link linkend="GRelation">GRelation</link> *relation);</programlisting>
 
252
<refsect2 id="g-relation-destroy" role="function">
 
253
<title>g_relation_destroy ()</title>
 
254
<indexterm zone="g-relation-destroy"><primary sortas="g_relation_destroy">g_relation_destroy</primary></indexterm><programlisting><link linkend="void">void</link>                g_relation_destroy                  (<link linkend="GRelation">GRelation</link> *relation);</programlisting>
271
255
<para>
272
256
Destroys the <link linkend="GRelation"><type>GRelation</type></link>, freeing all memory allocated.
273
257
However, it does not free memory allocated for the
274
258
tuple data, so you should free that first if appropriate.
275
259
</para><variablelist role="params">
276
 
<varlistentry><term><parameter>relation</parameter>&nbsp;:</term>
 
260
<varlistentry><term><parameter>relation</parameter>&#160;:</term>
277
261
<listitem><simpara>a <link linkend="GRelation"><type>GRelation</type></link>.
278
 
 
279
 
 
280
262
</simpara></listitem></varlistentry>
281
263
</variablelist></refsect2>
282
 
<refsect2>
283
 
<title><anchor id="g-relation-print" role="function"/>g_relation_print ()</title>
284
 
<indexterm><primary>g_relation_print</primary></indexterm><programlisting><link linkend="void">void</link>                g_relation_print                    (<link linkend="GRelation">GRelation</link> *relation);</programlisting>
 
264
<refsect2 id="g-relation-print" role="function">
 
265
<title>g_relation_print ()</title>
 
266
<indexterm zone="g-relation-print"><primary sortas="g_relation_print">g_relation_print</primary></indexterm><programlisting><link linkend="void">void</link>                g_relation_print                    (<link linkend="GRelation">GRelation</link> *relation);</programlisting>
285
267
<para>
286
268
Outputs information about all records in a <link linkend="GRelation"><type>GRelation</type></link>, as well as the indexes.
287
269
It is for debugging.
288
270
</para><variablelist role="params">
289
 
<varlistentry><term><parameter>relation</parameter>&nbsp;:</term>
 
271
<varlistentry><term><parameter>relation</parameter>&#160;:</term>
290
272
<listitem><simpara>a <link linkend="GRelation"><type>GRelation</type></link>.
291
 
 
292
 
 
293
273
</simpara></listitem></varlistentry>
294
274
</variablelist></refsect2>
295
 
<refsect2>
296
 
<title><anchor id="GTuples" role="struct"/>GTuples</title>
297
 
<indexterm><primary>GTuples</primary></indexterm><programlisting>typedef struct {
 
275
<refsect2 id="GTuples" role="struct">
 
276
<title>GTuples</title>
 
277
<indexterm zone="GTuples"><primary sortas="GTuples">GTuples</primary></indexterm><programlisting>typedef struct {
298
278
  guint len;
299
279
} GTuples;
300
280
</programlisting>
305
285
To access the matched records, you must use <link linkend="g-tuples-index"><function>g_tuples_index()</function></link>.
306
286
</para><variablelist role="struct">
307
287
<varlistentry>
308
 
<term><link linkend="guint">guint</link>&nbsp;<structfield>len</structfield>;</term>
 
288
<term><link linkend="guint">guint</link>&#160;<structfield>len</structfield>;</term>
309
289
<listitem><simpara>the number of records that matched.
310
 
 
311
290
</simpara></listitem>
312
291
</varlistentry>
313
292
</variablelist></refsect2>
314
 
<refsect2>
315
 
<title><anchor id="g-tuples-destroy" role="function"/>g_tuples_destroy ()</title>
316
 
<indexterm><primary>g_tuples_destroy</primary></indexterm><programlisting><link linkend="void">void</link>                g_tuples_destroy                    (<link linkend="GTuples">GTuples</link> *tuples);</programlisting>
 
293
<refsect2 id="g-tuples-destroy" role="function">
 
294
<title>g_tuples_destroy ()</title>
 
295
<indexterm zone="g-tuples-destroy"><primary sortas="g_tuples_destroy">g_tuples_destroy</primary></indexterm><programlisting><link linkend="void">void</link>                g_tuples_destroy                    (<link linkend="GTuples">GTuples</link> *tuples);</programlisting>
317
296
<para>
318
297
Frees the records which were returned by <link linkend="g-relation-select"><function>g_relation_select()</function></link>.
319
298
This should always be called after <link linkend="g-relation-select"><function>g_relation_select()</function></link> when you are
320
299
finished with the records.
321
300
The records are not removed from the <link linkend="GRelation"><type>GRelation</type></link>.
322
301
</para><variablelist role="params">
323
 
<varlistentry><term><parameter>tuples</parameter>&nbsp;:</term>
 
302
<varlistentry><term><parameter>tuples</parameter>&#160;:</term>
324
303
<listitem><simpara>the tuple data to free.
325
 
 
326
 
 
327
304
</simpara></listitem></varlistentry>
328
305
</variablelist></refsect2>
329
 
<refsect2>
330
 
<title><anchor id="g-tuples-index" role="function"/>g_tuples_index ()</title>
331
 
<indexterm><primary>g_tuples_index</primary></indexterm><programlisting><link linkend="gpointer">gpointer</link>            g_tuples_index                      (<link linkend="GTuples">GTuples</link> *tuples,
 
306
<refsect2 id="g-tuples-index" role="function">
 
307
<title>g_tuples_index ()</title>
 
308
<indexterm zone="g-tuples-index"><primary sortas="g_tuples_index">g_tuples_index</primary></indexterm><programlisting><link linkend="gpointer">gpointer</link>            g_tuples_index                      (<link linkend="GTuples">GTuples</link> *tuples,
332
309
                                                         <link linkend="gint">gint</link> index_,
333
310
                                                         <link linkend="gint">gint</link> field);</programlisting>
334
311
<para>
336
313
It returns the given field of the record at the given index.
337
314
The returned value should not be changed.
338
315
</para><variablelist role="params">
339
 
<varlistentry><term><parameter>tuples</parameter>&nbsp;:</term>
 
316
<varlistentry><term><parameter>tuples</parameter>&#160;:</term>
340
317
<listitem><simpara>the tuple data, returned by <link linkend="g-relation-select"><function>g_relation_select()</function></link>.
341
318
</simpara></listitem></varlistentry>
342
 
<varlistentry><term><parameter>index_</parameter>&nbsp;:</term>
 
319
<varlistentry><term><parameter>index_</parameter>&#160;:</term>
343
320
<listitem><simpara>the index of the record.
344
321
</simpara></listitem></varlistentry>
345
 
<varlistentry><term><parameter>field</parameter>&nbsp;:</term>
 
322
<varlistentry><term><parameter>field</parameter>&#160;:</term>
346
323
<listitem><simpara>the field to return.
347
324
</simpara></listitem></varlistentry>
348
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>the field of the record.
349
 
 
350
 
 
 
325
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>the field of the record.
351
326
</simpara></listitem></varlistentry>
352
327
</variablelist></refsect2>
353
328
 
356
331
 
357
332
 
358
333
 
359
 
 
360
 
<refsect1><refsect2 /><refsect2 /></refsect1>
361
334
</refentry>