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
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gda-command</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="index.html" title="GNOME Data Access manual">
<link rel="up" href="libgda-api.html" title="Client API Reference">
<link rel="prev" href="libgda-GdaClient.html" title="GdaClient">
<link rel="next" href="libgda-gda-config.html" title="gda-config">
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="introduction.html" title="Introduction">
<link rel="chapter" href="architecture.html" title="libgda architecture">
<link rel="chapter" href="installation.html" title="Installation">
<link rel="chapter" href="connecting.html" title="Beginning">
<link rel="chapter" href="processing-queries.html" title="Processing queries">
<link rel="chapter" href="ch06.html" title="Transactions and batch processes">
<link rel="chapter" href="managing-errors.html" title="Managing errors">
<link rel="chapter" href="main_example.html" title="Full example">
<link rel="chapter" href="migration.html" title="Some formulae for migration from old version">
<link rel="chapter" href="libgda-api.html" title="Client API Reference">
<link rel="chapter" href="libgda-providers.html" title="GDA Providers">
<link rel="chapter" href="libgda-xql.html" title="XML Queries">
<link rel="chapter" href="libgda-reports.html" title="GDA Report Engine">
<link rel="appendix" href="fdl.html" title="Appendix A. GNU Free Documentation License">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libgda-GdaClient.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgda-api.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GNOME Data Access manual</th>
<td><a accesskey="n" href="libgda-gda-config.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#libgda-gda-command.synopsis" class="shortcut">Top</a>
|
<a href="#libgda-gda-command.description" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libgda-gda-command"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgda-gda-command.top_of_page"></a>gda-command</span></h2>
<p>gda-command — Functions that deal with <a class="link" href="libgda-gda-command.html#GdaCommand" title="GdaCommand"><span class="type">GdaCommand</span></a></p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libgda-gda-command.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
enum <a class="link" href="libgda-gda-command.html#GdaCommandOptions" title="enum GdaCommandOptions">GdaCommandOptions</a>;
#define <a class="link" href="libgda-gda-command.html#GDA-COMMAND-DEFAULT-OPTION:CAPS" title="GDA_COMMAND_DEFAULT_OPTION">GDA_COMMAND_DEFAULT_OPTION</a>
enum <a class="link" href="libgda-gda-command.html#GdaCommandType" title="enum GdaCommandType">GdaCommandType</a>;
<a class="link" href="libgda-gda-command.html#GdaCommand" title="GdaCommand">GdaCommand</a>;
#define <a class="link" href="libgda-gda-command.html#GDA-TYPE-COMMAND:CAPS" title="GDA_TYPE_COMMAND">GDA_TYPE_COMMAND</a>
GType <a class="link" href="libgda-gda-command.html#gda-command-get-type" title="gda_command_get_type ()">gda_command_get_type</a> (void);
<a class="link" href="libgda-gda-command.html#GdaCommand" title="GdaCommand">GdaCommand</a>* <a class="link" href="libgda-gda-command.html#gda-command-new" title="gda_command_new ()">gda_command_new</a> (const gchar *text,
<a class="link" href="libgda-gda-command.html#GdaCommandType" title="enum GdaCommandType">GdaCommandType</a> type,
<a class="link" href="libgda-gda-command.html#GdaCommandOptions" title="enum GdaCommandOptions">GdaCommandOptions</a> options);
void <a class="link" href="libgda-gda-command.html#gda-command-free" title="gda_command_free ()">gda_command_free</a> (<a class="link" href="libgda-gda-command.html#GdaCommand" title="GdaCommand">GdaCommand</a> *cmd);
<a class="link" href="libgda-gda-command.html#GdaCommand" title="GdaCommand">GdaCommand</a>* <a class="link" href="libgda-gda-command.html#gda-command-copy" title="gda_command_copy ()">gda_command_copy</a> (<a class="link" href="libgda-gda-command.html#GdaCommand" title="GdaCommand">GdaCommand</a> *cmd);
const gchar* <a class="link" href="libgda-gda-command.html#gda-command-get-text" title="gda_command_get_text ()">gda_command_get_text</a> (<a class="link" href="libgda-gda-command.html#GdaCommand" title="GdaCommand">GdaCommand</a> *cmd);
void <a class="link" href="libgda-gda-command.html#gda-command-set-text" title="gda_command_set_text ()">gda_command_set_text</a> (<a class="link" href="libgda-gda-command.html#GdaCommand" title="GdaCommand">GdaCommand</a> *cmd,
const gchar *text);
<a class="link" href="libgda-gda-command.html#GdaCommandType" title="enum GdaCommandType">GdaCommandType</a> <a class="link" href="libgda-gda-command.html#gda-command-get-command-type" title="gda_command_get_command_type ()">gda_command_get_command_type</a> (<a class="link" href="libgda-gda-command.html#GdaCommand" title="GdaCommand">GdaCommand</a> *cmd);
void <a class="link" href="libgda-gda-command.html#gda-command-set-command-type" title="gda_command_set_command_type ()">gda_command_set_command_type</a> (<a class="link" href="libgda-gda-command.html#GdaCommand" title="GdaCommand">GdaCommand</a> *cmd,
<a class="link" href="libgda-gda-command.html#GdaCommandType" title="enum GdaCommandType">GdaCommandType</a> type);
<a class="link" href="libgda-gda-command.html#GdaCommandOptions" title="enum GdaCommandOptions">GdaCommandOptions</a> <a class="link" href="libgda-gda-command.html#gda-command-get-options" title="gda_command_get_options ()">gda_command_get_options</a> (<a class="link" href="libgda-gda-command.html#GdaCommand" title="GdaCommand">GdaCommand</a> *cmd);
void <a class="link" href="libgda-gda-command.html#gda-command-set-options" title="gda_command_set_options ()">gda_command_set_options</a> (<a class="link" href="libgda-gda-command.html#GdaCommand" title="GdaCommand">GdaCommand</a> *cmd,
<a class="link" href="libgda-gda-command.html#GdaCommandOptions" title="enum GdaCommandOptions">GdaCommandOptions</a> options);
GdaTransaction* <a class="link" href="libgda-gda-command.html#gda-command-get-transaction" title="gda_command_get_transaction ()">gda_command_get_transaction</a> (<a class="link" href="libgda-gda-command.html#GdaCommand" title="GdaCommand">GdaCommand</a> *cmd);
void <a class="link" href="libgda-gda-command.html#gda-command-set-transaction" title="gda_command_set_transaction ()">gda_command_set_transaction</a> (<a class="link" href="libgda-gda-command.html#GdaCommand" title="GdaCommand">GdaCommand</a> *cmd,
GdaTransaction *xaction);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="libgda-gda-command.description"></a><h2>Description</h2>
<p>
The <a class="link" href="libgda-gda-command.html#GdaCommand" title="GdaCommand"><span class="type">GdaCommand</span></a> structure holds data needed to issue a command to the
providers.
Applications usually create a <a class="link" href="libgda-gda-command.html#GdaCommand" title="GdaCommand"><span class="type">GdaCommand</span></a> (via <a class="link" href="libgda-gda-command.html#gda-command-new" title="gda_command_new ()"><span class="type">gda_command_new</span></a>), set its
properties (via the gda_command_set_* functions) and pass it over to the
database using the <span class="type">GdaConnection</span> functions.
</p>
<p>
One interesting thing about <a class="link" href="libgda-gda-command.html#GdaCommand" title="GdaCommand"><span class="type">GdaCommand</span></a>'s is that they can be reused over
and over. That is, applications don't need to create a command every time
they want to run something on the connected database. Moreover, the ability
to create command strings with placeholders allows the use of parameters to
specify the values for those placeholders. Thus, an application can create a
command of the form:
</p>
<pre class="programlisting">
INSERT INTO employees VALUES (%id, %name, %address, %salary)
</pre>
<p>
and reuse the same command over and over, just using different values for the
placeholders.
</p>
<p>
The value for the placeholders is specified when sending the <a class="link" href="libgda-gda-command.html#GdaCommand" title="GdaCommand"><span class="type">GdaCommand</span></a> to a
database connection, which is done via the <span class="type">gda_connection_execute</span> function.
</p>
</div>
<div class="refsect1" lang="en">
<a name="libgda-gda-command.details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="GdaCommandOptions"></a><h3>enum GdaCommandOptions</h3>
<pre class="programlisting">typedef enum {
GDA_COMMAND_OPTION_IGNORE_ERRORS = 1,
GDA_COMMAND_OPTION_STOP_ON_ERRORS = 1 << 1,
GDA_COMMAND_OPTION_BAD_OPTION = 1 << 2
} GdaCommandOptions;
</pre>
<p>
And OR'ed combination of GDA_COMMAND_OPTIONS_* values.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="GDA-COMMAND-DEFAULT-OPTION:CAPS"></a><h3>GDA_COMMAND_DEFAULT_OPTION</h3>
<pre class="programlisting">#define GDA_COMMAND_DEFAULT_OPTION GDA_COMMAND_OPTION_IGNORE_ERRORS
</pre>
<p>
This value is the one set by default. Currently is equal to
<span class="type">GDA_COMMAND_OPTION_STOP_ON_ERRORS</span>.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="GdaCommandType"></a><h3>enum GdaCommandType</h3>
<pre class="programlisting">typedef enum {
GDA_COMMAND_TYPE_SQL,
GDA_COMMAND_TYPE_XML,
GDA_COMMAND_TYPE_PROCEDURE,
GDA_COMMAND_TYPE_TABLE,
GDA_COMMAND_TYPE_SCHEMA,
GDA_COMMAND_TYPE_INVALID
} GdaCommandType;
</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="GDA-COMMAND-TYPE-SQL:CAPS"></a><span class="term"><code class="literal">GDA_COMMAND_TYPE_SQL</code></span></p></td>
<td>the text of the command is composed of zero or more SQL
sentences.
</td>
</tr>
<tr>
<td><p><a name="GDA-COMMAND-TYPE-XML:CAPS"></a><span class="term"><code class="literal">GDA_COMMAND_TYPE_XML</code></span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><a name="GDA-COMMAND-TYPE-PROCEDURE:CAPS"></a><span class="term"><code class="literal">GDA_COMMAND_TYPE_PROCEDURE</code></span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><a name="GDA-COMMAND-TYPE-TABLE:CAPS"></a><span class="term"><code class="literal">GDA_COMMAND_TYPE_TABLE</code></span></p></td>
<td>the text of the command is composed of zero or more
table names.
</td>
</tr>
<tr>
<td><p><a name="GDA-COMMAND-TYPE-SCHEMA:CAPS"></a><span class="term"><code class="literal">GDA_COMMAND_TYPE_SCHEMA</code></span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><a name="GDA-COMMAND-TYPE-INVALID:CAPS"></a><span class="term"><code class="literal">GDA_COMMAND_TYPE_INVALID</code></span></p></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="GdaCommand"></a><h3>GdaCommand</h3>
<pre class="programlisting">typedef struct {
gchar *text;
GdaCommandType type;
GdaCommandOptions options;
GdaTransaction *xaction;
} GdaCommand;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="GDA-TYPE-COMMAND:CAPS"></a><h3>GDA_TYPE_COMMAND</h3>
<pre class="programlisting">#define GDA_TYPE_COMMAND (gda_command_get_type ())
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gda-command-get-type"></a><h3>gda_command_get_type ()</h3>
<pre class="programlisting">GType gda_command_get_type (void);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gda-command-new"></a><h3>gda_command_new ()</h3>
<pre class="programlisting"><a class="link" href="libgda-gda-command.html#GdaCommand" title="GdaCommand">GdaCommand</a>* gda_command_new (const gchar *text,
<a class="link" href="libgda-gda-command.html#GdaCommandType" title="enum GdaCommandType">GdaCommandType</a> type,
<a class="link" href="libgda-gda-command.html#GdaCommandOptions" title="enum GdaCommandOptions">GdaCommandOptions</a> options);</pre>
<p>
Creates a new <a class="link" href="libgda-gda-command.html#GdaCommand" title="GdaCommand"><span class="type">GdaCommand</span></a> from the parameters that should be freed by
calling <a class="link" href="libgda-gda-command.html#gda-command-free" title="gda_command_free ()"><span class="type">gda_command_free</span></a>.
</p>
<p>
If there are conflicting options, this will set <em class="parameter"><code>options</code></em> to
<span class="type">GDA_COMMAND_OPTION_DEFAULT</span>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
<td> the text of the command.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td> a <a class="link" href="libgda-gda-command.html#GdaCommandType" title="enum GdaCommandType"><span class="type">GdaCommandType</span></a> value.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>options</code></em> :</span></p></td>
<td> a <a class="link" href="libgda-gda-command.html#GdaCommandOptions" title="enum GdaCommandOptions"><span class="type">GdaCommandOptions</span></a> value.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a newly allocated <a class="link" href="libgda-gda-command.html#GdaCommand" title="GdaCommand"><span class="type">GdaCommand</span></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gda-command-free"></a><h3>gda_command_free ()</h3>
<pre class="programlisting">void gda_command_free (<a class="link" href="libgda-gda-command.html#GdaCommand" title="GdaCommand">GdaCommand</a> *cmd);</pre>
<p>
Frees the resources allocated by <a class="link" href="libgda-gda-command.html#gda-command-new" title="gda_command_new ()"><span class="type">gda_command_new</span></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>cmd</code></em> :</span></p></td>
<td> a <a class="link" href="libgda-gda-command.html#GdaCommand" title="GdaCommand"><span class="type">GdaCommand</span></a>.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gda-command-copy"></a><h3>gda_command_copy ()</h3>
<pre class="programlisting"><a class="link" href="libgda-gda-command.html#GdaCommand" title="GdaCommand">GdaCommand</a>* gda_command_copy (<a class="link" href="libgda-gda-command.html#GdaCommand" title="GdaCommand">GdaCommand</a> *cmd);</pre>
<p>
Creates a new <a class="link" href="libgda-gda-command.html#GdaCommand" title="GdaCommand"><span class="type">GdaCommand</span></a> from an existing one.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>cmd</code></em> :</span></p></td>
<td> command to get a copy from.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a newly allocated <a class="link" href="libgda-gda-command.html#GdaCommand" title="GdaCommand"><span class="type">GdaCommand</span></a> with a copy of the data in <em class="parameter"><code>cmd</code></em>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gda-command-get-text"></a><h3>gda_command_get_text ()</h3>
<pre class="programlisting">const gchar* gda_command_get_text (<a class="link" href="libgda-gda-command.html#GdaCommand" title="GdaCommand">GdaCommand</a> *cmd);</pre>
<p>
Gets the command text held by <em class="parameter"><code>cmd</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>cmd</code></em> :</span></p></td>
<td> a <a class="link" href="libgda-gda-command.html#GdaCommand" title="GdaCommand"><span class="type">GdaCommand</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the command string of <em class="parameter"><code>cmd</code></em>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gda-command-set-text"></a><h3>gda_command_set_text ()</h3>
<pre class="programlisting">void gda_command_set_text (<a class="link" href="libgda-gda-command.html#GdaCommand" title="GdaCommand">GdaCommand</a> *cmd,
const gchar *text);</pre>
<p>
Sets the command text of <em class="parameter"><code>cmd</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>cmd</code></em> :</span></p></td>
<td> a <a class="link" href="libgda-gda-command.html#GdaCommand" title="GdaCommand"><span class="type">GdaCommand</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
<td> the command text.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gda-command-get-command-type"></a><h3>gda_command_get_command_type ()</h3>
<pre class="programlisting"><a class="link" href="libgda-gda-command.html#GdaCommandType" title="enum GdaCommandType">GdaCommandType</a> gda_command_get_command_type (<a class="link" href="libgda-gda-command.html#GdaCommand" title="GdaCommand">GdaCommand</a> *cmd);</pre>
<p>
Gets the command type of <em class="parameter"><code>cmd</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>cmd</code></em> :</span></p></td>
<td> a <a class="link" href="libgda-gda-command.html#GdaCommand" title="GdaCommand"><span class="type">GdaCommand</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the command type of <em class="parameter"><code>cmd</code></em>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gda-command-set-command-type"></a><h3>gda_command_set_command_type ()</h3>
<pre class="programlisting">void gda_command_set_command_type (<a class="link" href="libgda-gda-command.html#GdaCommand" title="GdaCommand">GdaCommand</a> *cmd,
<a class="link" href="libgda-gda-command.html#GdaCommandType" title="enum GdaCommandType">GdaCommandType</a> type);</pre>
<p>
Sets the command type of <em class="parameter"><code>cmd</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>cmd</code></em> :</span></p></td>
<td> a <a class="link" href="libgda-gda-command.html#GdaCommand" title="GdaCommand"><span class="type">GdaCommand</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td> the command type.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gda-command-get-options"></a><h3>gda_command_get_options ()</h3>
<pre class="programlisting"><a class="link" href="libgda-gda-command.html#GdaCommandOptions" title="enum GdaCommandOptions">GdaCommandOptions</a> gda_command_get_options (<a class="link" href="libgda-gda-command.html#GdaCommand" title="GdaCommand">GdaCommand</a> *cmd);</pre>
<p>
Gets the command options of <em class="parameter"><code>cmd</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>cmd</code></em> :</span></p></td>
<td> a <a class="link" href="libgda-gda-command.html#GdaCommand" title="GdaCommand"><span class="type">GdaCommand</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the command options of <em class="parameter"><code>cmd</code></em>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gda-command-set-options"></a><h3>gda_command_set_options ()</h3>
<pre class="programlisting">void gda_command_set_options (<a class="link" href="libgda-gda-command.html#GdaCommand" title="GdaCommand">GdaCommand</a> *cmd,
<a class="link" href="libgda-gda-command.html#GdaCommandOptions" title="enum GdaCommandOptions">GdaCommandOptions</a> options);</pre>
<p>
Sets the command options of <em class="parameter"><code>cmd</code></em>. If there conflicting options, it will just
leave the value as before.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>cmd</code></em> :</span></p></td>
<td> a <a class="link" href="libgda-gda-command.html#GdaCommand" title="GdaCommand"><span class="type">GdaCommand</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>options</code></em> :</span></p></td>
<td> the command options.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gda-command-get-transaction"></a><h3>gda_command_get_transaction ()</h3>
<pre class="programlisting">GdaTransaction* gda_command_get_transaction (<a class="link" href="libgda-gda-command.html#GdaCommand" title="GdaCommand">GdaCommand</a> *cmd);</pre>
<p>
Gets the <span class="type">GdaTransaction</span> associated with the given <a class="link" href="libgda-gda-command.html#GdaCommand" title="GdaCommand"><span class="type">GdaCommand</span></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>cmd</code></em> :</span></p></td>
<td> a <a class="link" href="libgda-gda-command.html#GdaCommand" title="GdaCommand"><span class="type">GdaCommand</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the transaction for the command.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gda-command-set-transaction"></a><h3>gda_command_set_transaction ()</h3>
<pre class="programlisting">void gda_command_set_transaction (<a class="link" href="libgda-gda-command.html#GdaCommand" title="GdaCommand">GdaCommand</a> *cmd,
GdaTransaction *xaction);</pre>
<p>
Sets the <span class="type">GdaTransaction</span> associated with the given <a class="link" href="libgda-gda-command.html#GdaCommand" title="GdaCommand"><span class="type">GdaCommand</span></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>cmd</code></em> :</span></p></td>
<td> a <a class="link" href="libgda-gda-command.html#GdaCommand" title="GdaCommand"><span class="type">GdaCommand</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>xaction</code></em> :</span></p></td>
<td> a <span class="type">GdaTransaction</span> object.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.10</div>
</body>
</html>
|
