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
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
|
<refentry id="libgda-gda-parameter">
<refmeta>
<refentrytitle role="top_of_page" id="libgda-gda-parameter.top_of_page">gda-parameter</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGDA Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gda-parameter</refname>
<refpurpose>Management of parameters</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="libgda-gda-parameter.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="GdaParameter">GdaParameter</link>;
#define <link linkend="GDA-TYPE-PARAMETER:CAPS">GDA_TYPE_PARAMETER</link>
<link linkend="GType">GType</link> <link linkend="gda-parameter-get-type">gda_parameter_get_type</link> (void);
<link linkend="GdaParameter">GdaParameter</link>* <link linkend="gda-parameter-new-from-value">gda_parameter_new_from_value</link> (const <link linkend="gchar">gchar</link> *name,
const <link linkend="GdaValue">GdaValue</link> *value);
<link linkend="GdaParameter">GdaParameter</link>* <link linkend="gda-parameter-new-boolean">gda_parameter_new_boolean</link> (const <link linkend="gchar">gchar</link> *name,
<link linkend="gboolean">gboolean</link> value);
<link linkend="GdaParameter">GdaParameter</link>* <link linkend="gda-parameter-new-double">gda_parameter_new_double</link> (const <link linkend="gchar">gchar</link> *name,
<link linkend="gdouble">gdouble</link> value);
<link linkend="GdaParameter">GdaParameter</link>* <link linkend="gda-parameter-new-gobject">gda_parameter_new_gobject</link> (const <link linkend="gchar">gchar</link> *name,
const <link linkend="GObject">GObject</link> *value);
<link linkend="GdaParameter">GdaParameter</link>* <link linkend="gda-parameter-new-string">gda_parameter_new_string</link> (const <link linkend="gchar">gchar</link> *name,
const <link linkend="gchar">gchar</link> *value);
<link linkend="GdaParameter">GdaParameter</link>* <link linkend="gda-parameter-copy">gda_parameter_copy</link> (<link linkend="GdaParameter">GdaParameter</link> *param);
<link linkend="void">void</link> <link linkend="gda-parameter-free">gda_parameter_free</link> (<link linkend="GdaParameter">GdaParameter</link> *param);
const <link linkend="gchar">gchar</link>* <link linkend="gda-parameter-get-name">gda_parameter_get_name</link> (<link linkend="GdaParameter">GdaParameter</link> *param);
<link linkend="void">void</link> <link linkend="gda-parameter-set-name">gda_parameter_set_name</link> (<link linkend="GdaParameter">GdaParameter</link> *param,
const <link linkend="gchar">gchar</link> *name);
const <link linkend="GdaValue">GdaValue</link>* <link linkend="gda-parameter-get-value">gda_parameter_get_value</link> (<link linkend="GdaParameter">GdaParameter</link> *param);
<link linkend="void">void</link> <link linkend="gda-parameter-set-value">gda_parameter_set_value</link> (<link linkend="GdaParameter">GdaParameter</link> *param,
<link linkend="GdaValue">GdaValue</link> *value);
<link linkend="GdaParameterList">GdaParameterList</link>;
#define <link linkend="GDA-TYPE-PARAMETER-LIST:CAPS">GDA_TYPE_PARAMETER_LIST</link>
<link linkend="GType">GType</link> <link linkend="gda-parameter-list-get-type">gda_parameter_list_get_type</link> (void);
<link linkend="GdaParameterList">GdaParameterList</link>* <link linkend="gda-parameter-list-new">gda_parameter_list_new</link> (void);
<link linkend="void">void</link> <link linkend="gda-parameter-list-free">gda_parameter_list_free</link> (<link linkend="GdaParameterList">GdaParameterList</link> *plist);
<link linkend="GdaParameterList">GdaParameterList</link>* <link linkend="gda-parameter-list-copy">gda_parameter_list_copy</link> (<link linkend="GdaParameterList">GdaParameterList</link> *plist);
<link linkend="void">void</link> <link linkend="gda-parameter-list-add-parameter">gda_parameter_list_add_parameter</link> (<link linkend="GdaParameterList">GdaParameterList</link> *plist,
<link linkend="GdaParameter">GdaParameter</link> *param);
<link linkend="GList">GList</link>* <link linkend="gda-parameter-list-get-names">gda_parameter_list_get_names</link> (<link linkend="GdaParameterList">GdaParameterList</link> *plist);
<link linkend="GdaParameter">GdaParameter</link>* <link linkend="gda-parameter-list-find">gda_parameter_list_find</link> (<link linkend="GdaParameterList">GdaParameterList</link> *plist,
const <link linkend="gchar">gchar</link> *name);
<link linkend="void">void</link> <link linkend="gda-parameter-list-clear">gda_parameter_list_clear</link> (<link linkend="GdaParameterList">GdaParameterList</link> *plist);
<link linkend="guint">guint</link> <link linkend="gda-parameter-list-get-length">gda_parameter_list_get_length</link> (<link linkend="GdaParameterList">GdaParameterList</link> *plist);
</synopsis>
</refsynopsisdiv>
<refsect1 id="libgda-gda-parameter.description" role="desc">
<title role="desc.title">Description</title>
<para>
Parameters are the way clients have to send an unlimited number
of arguments to the providers.
</para>
</refsect1>
<refsect1 id="libgda-gda-parameter.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="GdaParameter" role="struct">
<title>GdaParameter</title>
<indexterm zone="GdaParameter"><primary>GdaParameter</primary></indexterm><programlisting>typedef struct {
gchar *name;
GdaValue *value;
} GdaParameter;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="GDA-TYPE-PARAMETER:CAPS" role="macro">
<title>GDA_TYPE_PARAMETER</title>
<indexterm zone="GDA-TYPE-PARAMETER:CAPS"><primary>GDA_TYPE_PARAMETER</primary></indexterm><programlisting>#define GDA_TYPE_PARAMETER (gda_parameter_get_type())
</programlisting>
<para>
</para></refsect2>
<refsect2 id="gda-parameter-get-type" role="function">
<title>gda_parameter_get_type ()</title>
<indexterm zone="gda-parameter-get-type"><primary>gda_parameter_get_type</primary></indexterm><programlisting><link linkend="GType">GType</link> gda_parameter_get_type (void);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-parameter-new-from-value" role="function">
<title>gda_parameter_new_from_value ()</title>
<indexterm zone="gda-parameter-new-from-value"><primary>gda_parameter_new_from_value</primary></indexterm><programlisting><link linkend="GdaParameter">GdaParameter</link>* gda_parameter_new_from_value (const <link linkend="gchar">gchar</link> *name,
const <link linkend="GdaValue">GdaValue</link> *value);</programlisting>
<para>
Creates a new <link linkend="GdaParameter"><type>GdaParameter</type></link> object, which is usually used
with <link linkend="GdaParameterList"><type>GdaParameterList</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> name for the parameter being created.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter> :</term>
<listitem><simpara> a <link linkend="GdaValue"><type>GdaValue</type></link> for this parameter.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the newly created <link linkend="GdaParameter"><type>GdaParameter</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-parameter-new-boolean" role="function">
<title>gda_parameter_new_boolean ()</title>
<indexterm zone="gda-parameter-new-boolean"><primary>gda_parameter_new_boolean</primary></indexterm><programlisting><link linkend="GdaParameter">GdaParameter</link>* gda_parameter_new_boolean (const <link linkend="gchar">gchar</link> *name,
<link linkend="gboolean">gboolean</link> value);</programlisting>
<para>
Creates a new <link linkend="GdaParameter"><type>GdaParameter</type></link> from a gboolean value.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> name for the parameter being created.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter> :</term>
<listitem><simpara> a boolean value.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the newly created <link linkend="GdaParameter"><type>GdaParameter</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-parameter-new-double" role="function">
<title>gda_parameter_new_double ()</title>
<indexterm zone="gda-parameter-new-double"><primary>gda_parameter_new_double</primary></indexterm><programlisting><link linkend="GdaParameter">GdaParameter</link>* gda_parameter_new_double (const <link linkend="gchar">gchar</link> *name,
<link linkend="gdouble">gdouble</link> value);</programlisting>
<para>
Creates a new <link linkend="GdaParameter"><type>GdaParameter</type></link> from a gdouble value.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> name for the parameter being created.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter> :</term>
<listitem><simpara> a gdouble value.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the newly created <link linkend="GdaParameter"><type>GdaParameter</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-parameter-new-gobject" role="function">
<title>gda_parameter_new_gobject ()</title>
<indexterm zone="gda-parameter-new-gobject"><primary>gda_parameter_new_gobject</primary></indexterm><programlisting><link linkend="GdaParameter">GdaParameter</link>* gda_parameter_new_gobject (const <link linkend="gchar">gchar</link> *name,
const <link linkend="GObject">GObject</link> *value);</programlisting>
<para>
Creates a new <link linkend="GdaParameter"><type>GdaParameter</type></link> from a GObject.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> name for the parameter being created.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter> :</term>
<listitem><simpara> a GObject value.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the newly created <link linkend="GdaParameter"><type>GdaParameter</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-parameter-new-string" role="function">
<title>gda_parameter_new_string ()</title>
<indexterm zone="gda-parameter-new-string"><primary>gda_parameter_new_string</primary></indexterm><programlisting><link linkend="GdaParameter">GdaParameter</link>* gda_parameter_new_string (const <link linkend="gchar">gchar</link> *name,
const <link linkend="gchar">gchar</link> *value);</programlisting>
<para>
Creates a new <link linkend="GdaParameter"><type>GdaParameter</type></link> from a string.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> name for the parameter being created.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter> :</term>
<listitem><simpara> string value.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the newly created <link linkend="GdaParameter"><type>GdaParameter</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-parameter-copy" role="function">
<title>gda_parameter_copy ()</title>
<indexterm zone="gda-parameter-copy"><primary>gda_parameter_copy</primary></indexterm><programlisting><link linkend="GdaParameter">GdaParameter</link>* gda_parameter_copy (<link linkend="GdaParameter">GdaParameter</link> *param);</programlisting>
<para>
Creates a new <link linkend="GdaParameter"><type>GdaParameter</type></link> from an existing one.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>param</parameter> :</term>
<listitem><simpara> parameter to get a copy from.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a newly allocated <link linkend="GdaParameter"><type>GdaParameter</type></link> with a copy of the data in <parameter>param</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-parameter-free" role="function">
<title>gda_parameter_free ()</title>
<indexterm zone="gda-parameter-free"><primary>gda_parameter_free</primary></indexterm><programlisting><link linkend="void">void</link> gda_parameter_free (<link linkend="GdaParameter">GdaParameter</link> *param);</programlisting>
<para>
Releases all memory occupied by the given <link linkend="GdaParameter"><type>GdaParameter</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>param</parameter> :</term>
<listitem><simpara> the <link linkend="GdaParameter"><type>GdaParameter</type></link> to be freed.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-parameter-get-name" role="function">
<title>gda_parameter_get_name ()</title>
<indexterm zone="gda-parameter-get-name"><primary>gda_parameter_get_name</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gda_parameter_get_name (<link linkend="GdaParameter">GdaParameter</link> *param);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>param</parameter> :</term>
<listitem><simpara> a <link linkend="GdaParameter"><type>GdaParameter</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the name of the given <link linkend="GdaParameter"><type>GdaParameter</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-parameter-set-name" role="function">
<title>gda_parameter_set_name ()</title>
<indexterm zone="gda-parameter-set-name"><primary>gda_parameter_set_name</primary></indexterm><programlisting><link linkend="void">void</link> gda_parameter_set_name (<link linkend="GdaParameter">GdaParameter</link> *param,
const <link linkend="gchar">gchar</link> *name);</programlisting>
<para>
Sets the name of the given <link linkend="GdaParameter"><type>GdaParameter</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>param</parameter> :</term>
<listitem><simpara> a <link linkend="GdaParameter"><type>GdaParameter</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> new name for the parameter.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-parameter-get-value" role="function">
<title>gda_parameter_get_value ()</title>
<indexterm zone="gda-parameter-get-value"><primary>gda_parameter_get_value</primary></indexterm><programlisting>const <link linkend="GdaValue">GdaValue</link>* gda_parameter_get_value (<link linkend="GdaParameter">GdaParameter</link> *param);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>param</parameter> :</term>
<listitem><simpara> a <link linkend="GdaParameter"><type>GdaParameter</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the value stored in the given <parameter>param</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-parameter-set-value" role="function">
<title>gda_parameter_set_value ()</title>
<indexterm zone="gda-parameter-set-value"><primary>gda_parameter_set_value</primary></indexterm><programlisting><link linkend="void">void</link> gda_parameter_set_value (<link linkend="GdaParameter">GdaParameter</link> *param,
<link linkend="GdaValue">GdaValue</link> *value);</programlisting>
<para>
Stores the given <parameter>value</parameter> in the given <parameter>param</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>param</parameter> :</term>
<listitem><simpara> a <link linkend="GdaParameter"><type>GdaParameter</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter> :</term>
<listitem><simpara> a <link linkend="GdaValue"><type>GdaValue</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="GdaParameterList" role="struct">
<title>GdaParameterList</title>
<indexterm zone="GdaParameterList"><primary>GdaParameterList</primary></indexterm><programlisting>typedef struct _GdaParameterList GdaParameterList;</programlisting>
<para>
</para></refsect2>
<refsect2 id="GDA-TYPE-PARAMETER-LIST:CAPS" role="macro">
<title>GDA_TYPE_PARAMETER_LIST</title>
<indexterm zone="GDA-TYPE-PARAMETER-LIST:CAPS"><primary>GDA_TYPE_PARAMETER_LIST</primary></indexterm><programlisting>#define GDA_TYPE_PARAMETER_LIST (gda_parameter_list_get_type())
</programlisting>
<para>
</para></refsect2>
<refsect2 id="gda-parameter-list-get-type" role="function">
<title>gda_parameter_list_get_type ()</title>
<indexterm zone="gda-parameter-list-get-type"><primary>gda_parameter_list_get_type</primary></indexterm><programlisting><link linkend="GType">GType</link> gda_parameter_list_get_type (void);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-parameter-list-new" role="function">
<title>gda_parameter_list_new ()</title>
<indexterm zone="gda-parameter-list-new"><primary>gda_parameter_list_new</primary></indexterm><programlisting><link linkend="GdaParameterList">GdaParameterList</link>* gda_parameter_list_new (void);</programlisting>
<para>
Creates a new <link linkend="GdaParameterList"><type>GdaParameterList</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the newly created parameter list.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-parameter-list-free" role="function">
<title>gda_parameter_list_free ()</title>
<indexterm zone="gda-parameter-list-free"><primary>gda_parameter_list_free</primary></indexterm><programlisting><link linkend="void">void</link> gda_parameter_list_free (<link linkend="GdaParameterList">GdaParameterList</link> *plist);</programlisting>
<para>
Releases all memory occupied by the given <link linkend="GdaParameterList"><type>GdaParameterList</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>plist</parameter> :</term>
<listitem><simpara> a <link linkend="GdaParameterList"><type>GdaParameterList</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-parameter-list-copy" role="function">
<title>gda_parameter_list_copy ()</title>
<indexterm zone="gda-parameter-list-copy"><primary>gda_parameter_list_copy</primary></indexterm><programlisting><link linkend="GdaParameterList">GdaParameterList</link>* gda_parameter_list_copy (<link linkend="GdaParameterList">GdaParameterList</link> *plist);</programlisting>
<para>
Creates a new <link linkend="GdaParameterList"><type>GdaParameterList</type></link> from an existing one.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>plist</parameter> :</term>
<listitem><simpara> parameter list to get a copy from.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a newly allocated <link linkend="GdaParameterList"><type>GdaParameterList</type></link> with a copy of the data in <parameter>plist</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-parameter-list-add-parameter" role="function">
<title>gda_parameter_list_add_parameter ()</title>
<indexterm zone="gda-parameter-list-add-parameter"><primary>gda_parameter_list_add_parameter</primary></indexterm><programlisting><link linkend="void">void</link> gda_parameter_list_add_parameter (<link linkend="GdaParameterList">GdaParameterList</link> *plist,
<link linkend="GdaParameter">GdaParameter</link> *param);</programlisting>
<para>
Adds a new parameter to the given <link linkend="GdaParameterList"><type>GdaParameterList</type></link>. Note that <parameter>param</parameter> is,
when calling this function, is owned by the <link linkend="GdaParameterList"><type>GdaParameterList</type></link>, so the
caller should just forget about it and not try to free the parameter once
it's been added to the <link linkend="GdaParameterList"><type>GdaParameterList</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>plist</parameter> :</term>
<listitem><simpara> a <link linkend="GdaParameterList"><type>GdaParameterList</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>param</parameter> :</term>
<listitem><simpara> the <link linkend="GdaParameter"><type>GdaParameter</type></link> to be added to the list.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-parameter-list-get-names" role="function">
<title>gda_parameter_list_get_names ()</title>
<indexterm zone="gda-parameter-list-get-names"><primary>gda_parameter_list_get_names</primary></indexterm><programlisting><link linkend="GList">GList</link>* gda_parameter_list_get_names (<link linkend="GdaParameterList">GdaParameterList</link> *plist);</programlisting>
<para>
Gets the names of all parameters in the parameter list.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>plist</parameter> :</term>
<listitem><simpara> a <link linkend="GdaParameterList"><type>GdaParameterList</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a GList containing the names of the parameters. After
using it, you should free this list by calling g_list_free.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-parameter-list-find" role="function">
<title>gda_parameter_list_find ()</title>
<indexterm zone="gda-parameter-list-find"><primary>gda_parameter_list_find</primary></indexterm><programlisting><link linkend="GdaParameter">GdaParameter</link>* gda_parameter_list_find (<link linkend="GdaParameterList">GdaParameterList</link> *plist,
const <link linkend="gchar">gchar</link> *name);</programlisting>
<para>
Gets a <link linkend="GdaParameter"><type>GdaParameter</type></link> from the parameter list given its name.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>plist</parameter> :</term>
<listitem><simpara> a <link linkend="GdaParameterList"><type>GdaParameterList</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> name of the parameter to search for.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the <link linkend="GdaParameter"><type>GdaParameter</type></link> identified by <parameter>name</parameter>, if found, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
if not found.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-parameter-list-clear" role="function">
<title>gda_parameter_list_clear ()</title>
<indexterm zone="gda-parameter-list-clear"><primary>gda_parameter_list_clear</primary></indexterm><programlisting><link linkend="void">void</link> gda_parameter_list_clear (<link linkend="GdaParameterList">GdaParameterList</link> *plist);</programlisting>
<para>
Clears the parameter list. This means removing all <link linkend="GdaParameter"><type>GdaParameter</type></link>'s currently
being stored in the parameter list. After calling this function,
the parameter list is empty.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>plist</parameter> :</term>
<listitem><simpara> a <link linkend="GdaParameterList"><type>GdaParameterList</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-parameter-list-get-length" role="function">
<title>gda_parameter_list_get_length ()</title>
<indexterm zone="gda-parameter-list-get-length"><primary>gda_parameter_list_get_length</primary></indexterm><programlisting><link linkend="guint">guint</link> gda_parameter_list_get_length (<link linkend="GdaParameterList">GdaParameterList</link> *plist);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>plist</parameter> :</term>
<listitem><simpara> a <link linkend="GdaParameterList"><type>GdaParameterList</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the number of parameters stored in the given parameter list.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
