File: classGnome_1_1Gda_1_1DictFunction.html

package info (click to toggle)
libgdamm3.0 3.0.0-2
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 13,804 kB
  • ctags: 6,365
  • sloc: xml: 14,451; sh: 8,913; cpp: 1,473; makefile: 138; perl: 108
file content (487 lines) | stat: -rw-r--r-- 32,269 bytes parent folder | download
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>libgdamm: Gnome::Gda::DictFunction Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head>
<body bgcolor="#ffffff">
<table border="0" width="100%">
<tr>
    <td>libgdamm Reference Documentation</td>
</tr>
</table>
<center>
  <a class="qindex" href="../../../../../libgnomedbmm-3.0/docs/index.html">Main Page</a> &nbsp;
  <a class="qindex" href="namespaces.html"> Namespaces</a> &nbsp;
  <a href="../../../../../libgnomedbmm-3.0/docs/tutorial/html/index.html"> Book</a> &nbsp;
</center>
<hr width="100%"/>

<!-- Generated by Doxygen 1.5.1 -->
<div class="nav">
<a class="el" href="namespaceGnome.html">Gnome</a>::<a class="el" href="namespaceGnome_1_1Gda.html">Gda</a>::<a class="el" href="classGnome_1_1Gda_1_1DictFunction.html">DictFunction</a></div>
<h1>Gnome::Gda::DictFunction Class Reference</h1><!-- doxytag: class="Gnome::Gda::DictFunction" --><!-- doxytag: inherits="Gnome::Gda::Object,Gnome::Gda::XmlStorage" -->Represents a function in the DBMS.  
<a href="#_details">More...</a>
<p>
Inheritance diagram for Gnome::Gda::DictFunction:<p><center><img src="classGnome_1_1Gda_1_1DictFunction__inherit__graph.png" border="0" usemap="#Gnome_1_1Gda_1_1DictFunction__inherit__map" alt="Inheritance graph"></center>
<map name="Gnome_1_1Gda_1_1DictFunction__inherit__map">
<area href="classGnome_1_1Gda_1_1Object.html" shape="rect" coords="5,238,157,265" alt="">
<area doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1Object.html" shape="rect" coords="52,161,145,188" alt="">
<area doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1ObjectBase.html" shape="rect" coords="99,84,224,110" alt="">
<area doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1Interface.html" shape="rect" coords="203,161,312,188" alt="">
<area doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classsigc_1_1trackable.html" shape="rect" coords="105,6,217,33" alt="">
<area href="classGnome_1_1Gda_1_1XmlStorage.html" shape="rect" coords="181,238,368,265" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classGnome_1_1Gda_1_1DictFunction-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1DictFunction.html#ceb5eadb64fafcc5a0e630b8a402c1d8">accepts_arg_dict_types</a> (const <a class="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1SListHandle.html">Glib::SListHandle</a>&lt;<a class="el" href="classGnome_1_1Gda_1_1DictType.html">DictType</a>&gt;&amp; arg_types)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Test if the proposed list of arguments ( <em>arg_types</em>) would be accepted by the <em>func</em> function.  <a href="#ceb5eadb64fafcc5a0e630b8a402c1d8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1DictFunction.html#54f7b9b6a1c0420071dcfb24df3189c3">get_dbms_id</a> () const</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the DBMS identifier of the function.  <a href="#54f7b9b6a1c0420071dcfb24df3189c3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt;const <a class="el" href="classGnome_1_1Gda_1_1DictType.html">DictType</a>&gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1DictFunction.html#38b44686284dcc211b589c3c545c7f0f">get_ret_dict_type</a> () const</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">To consult the return type of a function.  <a href="#38b44686284dcc211b589c3c545c7f0f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt;<a class="el" href="classGnome_1_1Gda_1_1DictType.html">DictType</a>&gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1DictFunction.html#e3a6321bc44fbbe87066a15bdaa8cf30">get_ret_dict_type</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">To consult the return type of a function.  <a href="#e3a6321bc44fbbe87066a15bdaa8cf30"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1DictFunction.html#071e758177cc9940ea9bbdfdd7b4cb95">get_sqlname</a> () const</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the DBMS's name of a data type.  <a href="#071e758177cc9940ea9bbdfdd7b4cb95"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const GdaDictFunction*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1DictFunction.html#d4a1577ff73d58bdb6ad1e0bbe0e2124">gobj</a> () const</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Provides access to the underlying C GObject.  <a href="#d4a1577ff73d58bdb6ad1e0bbe0e2124"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">GdaDictFunction*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1DictFunction.html#9869b3c66aa039b269bf04ff782eb0a0">gobj</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Provides access to the underlying C GObject.  <a href="#9869b3c66aa039b269bf04ff782eb0a0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">GdaDictFunction*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1DictFunction.html#5976c360cf3fe0961b39a4f58bf1ed05">gobj_copy</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.  <a href="#5976c360cf3fe0961b39a4f58bf1ed05"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1DictFunction.html#68cc01342ee35e935fae6687c0d0fbc7">set_arg_dict_types</a> (const <a class="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1SListHandle.html">Glib::SListHandle</a>&lt;<a class="el" href="classGnome_1_1Gda_1_1DictType.html">DictType</a>&gt;&amp; arg_types)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the arguments types of a function.  <a href="#68cc01342ee35e935fae6687c0d0fbc7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1DictFunction.html#c86f780edeae97dae310d28a560360a3">set_dbms_id</a> (const <a class="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>&amp; id)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the DBMS identifier of the function.  <a href="#c86f780edeae97dae310d28a560360a3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1DictFunction.html#a09305f0a7f76722a69ec732b3d4dd0c">set_ret_dict_type</a> (const <a class="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt;<a class="el" href="classGnome_1_1Gda_1_1DictType.html">DictType</a>&gt;&amp; dt)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the return type of a function.  <a href="#a09305f0a7f76722a69ec732b3d4dd0c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1DictFunction.html#6df9b14310854b5bcf6ffed4429ceae0">set_sqlname</a> (const <a class="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>&amp; sqlname)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the SQL name of the data type.  <a href="#6df9b14310854b5bcf6ffed4429ceae0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1DictFunction.html#9b82a2a93c059e06dc3bfc2cecea1c38">~DictFunction</a> ()</td></tr>

<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt;<a class="el" href="classGnome_1_1Gda_1_1DictFunction.html">DictFunction</a>&gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1DictFunction.html#7c3297f0a3c5f6e541cb56dfc777a281">create</a> (const <a class="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt;<a class="el" href="classGnome_1_1Gda_1_1Dict.html">Dict</a>&gt;&amp; dict)</td></tr>

<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1DictFunction.html#ca5f1d0dd3d24c8ef54ac224b5f8cd0b">DictFunction</a> (const <a class="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt;<a class="el" href="classGnome_1_1Gda_1_1Dict.html">Dict</a>&gt;&amp; dict)</td></tr>

<tr><td colspan="2"><br><h2>Related Functions</h2></td></tr>
<tr><td colspan="2">(Note that these are not member functions.) <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt;<a class="el" href="classGnome_1_1Gda_1_1DictFunction.html">Gnome::Gda::DictFunction</a>&gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1DictFunction.html#a0042e71d194b0b73da26dd93176cfa7">wrap</a> (GdaDictFunction* object, bool take_copy=false)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A <a class="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/namespaceGlib.html#671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object.  <a href="#a0042e71d194b0b73da26dd93176cfa7"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Represents a function in the DBMS. 
<p>
<a class="el" href="classGnome_1_1Gda_1_1DictFunction.html">DictFunction</a> represents a function, with zero or more input parameters, and one and only one return type. Therefore it does not represent procedures which do not return any data type. Also the argument types are always of the IN kind (no OUT or IN OUT arguments). There may one day be a specific object for procedures. Likewise, it does not represent a function returning a SET OF a given data type. There may one day be a specific object for such functions.<p>
Because functions can be polymorphic, the name is not enough to identify them, so the DBMS provides a unique id which can be used to uniquely identify a function. 
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="9b82a2a93c059e06dc3bfc2cecea1c38"></a><!-- doxytag: member="Gnome::Gda::DictFunction::~DictFunction" ref="9b82a2a93c059e06dc3bfc2cecea1c38" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual Gnome::Gda::DictFunction::~DictFunction           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="ca5f1d0dd3d24c8ef54ac224b5f8cd0b"></a><!-- doxytag: member="Gnome::Gda::DictFunction::DictFunction" ref="ca5f1d0dd3d24c8ef54ac224b5f8cd0b" args="(const Glib::RefPtr&lt; Dict &gt; &amp;dict)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Gnome::Gda::DictFunction::DictFunction           </td>
          <td>(</td>
          <td class="paramtype">const <a class="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt;<a class="el" href="classGnome_1_1Gda_1_1Dict.html">Dict</a>&gt;&amp;&nbsp;</td>
          <td class="paramname"> <em>dict</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [explicit, protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="ceb5eadb64fafcc5a0e630b8a402c1d8"></a><!-- doxytag: member="Gnome::Gda::DictFunction::accepts_arg_dict_types" ref="ceb5eadb64fafcc5a0e630b8a402c1d8" args="(const Glib::SListHandle&lt; DictType &gt; &amp;arg_types)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Gnome::Gda::DictFunction::accepts_arg_dict_types           </td>
          <td>(</td>
          <td class="paramtype">const <a class="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1SListHandle.html">Glib::SListHandle</a>&lt;<a class="el" href="classGnome_1_1Gda_1_1DictType.html">DictType</a>&gt;&amp;&nbsp;</td>
          <td class="paramname"> <em>arg_types</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Test if the proposed list of arguments ( <em>arg_types</em>) would be accepted by the <em>func</em> function. 
<p>
The non acceptance can be beause of data type incompatibilities or a wrong number of data types. <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>arg_types</em>&nbsp;</td><td>A list of <a class="el" href="classGnome_1_1Gda_1_1DictType.html">Gda::DictType</a> objects or #<code>0</code> values, ordered. </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>true</code> if accepted. </dd></dl>

</div>
</div><p>
<a class="anchor" name="7c3297f0a3c5f6e541cb56dfc777a281"></a><!-- doxytag: member="Gnome::Gda::DictFunction::create" ref="7c3297f0a3c5f6e541cb56dfc777a281" args="(const Glib::RefPtr&lt; Dict &gt; &amp;dict)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt;<a class="el" href="classGnome_1_1Gda_1_1DictFunction.html">DictFunction</a>&gt; Gnome::Gda::DictFunction::create           </td>
          <td>(</td>
          <td class="paramtype">const <a class="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt;<a class="el" href="classGnome_1_1Gda_1_1Dict.html">Dict</a>&gt;&amp;&nbsp;</td>
          <td class="paramname"> <em>dict</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="54f7b9b6a1c0420071dcfb24df3189c3"></a><!-- doxytag: member="Gnome::Gda::DictFunction::get_dbms_id" ref="54f7b9b6a1c0420071dcfb24df3189c3" args="() const" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> Gnome::Gda::DictFunction::get_dbms_id           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the DBMS identifier of the function. 
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A new string with the function's id. </dd></dl>

</div>
</div><p>
<a class="anchor" name="38b44686284dcc211b589c3c545c7f0f"></a><!-- doxytag: member="Gnome::Gda::DictFunction::get_ret_dict_type" ref="38b44686284dcc211b589c3c545c7f0f" args="() const" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt;const <a class="el" href="classGnome_1_1Gda_1_1DictType.html">DictType</a>&gt; Gnome::Gda::DictFunction::get_ret_dict_type           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
To consult the return type of a function. 
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A <a class="el" href="classGnome_1_1Gda_1_1DictType.html">Gda::DictType</a> object. </dd></dl>

</div>
</div><p>
<a class="anchor" name="e3a6321bc44fbbe87066a15bdaa8cf30"></a><!-- doxytag: member="Gnome::Gda::DictFunction::get_ret_dict_type" ref="e3a6321bc44fbbe87066a15bdaa8cf30" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt;<a class="el" href="classGnome_1_1Gda_1_1DictType.html">DictType</a>&gt; Gnome::Gda::DictFunction::get_ret_dict_type           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
To consult the return type of a function. 
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A <a class="el" href="classGnome_1_1Gda_1_1DictType.html">Gda::DictType</a> object. </dd></dl>

</div>
</div><p>
<a class="anchor" name="071e758177cc9940ea9bbdfdd7b4cb95"></a><!-- doxytag: member="Gnome::Gda::DictFunction::get_sqlname" ref="071e758177cc9940ea9bbdfdd7b4cb95" args="() const" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> Gnome::Gda::DictFunction::get_sqlname           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the DBMS's name of a data type. 
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The name of the data type. </dd></dl>

</div>
</div><p>
<a class="anchor" name="d4a1577ff73d58bdb6ad1e0bbe0e2124"></a><!-- doxytag: member="Gnome::Gda::DictFunction::gobj" ref="d4a1577ff73d58bdb6ad1e0bbe0e2124" args="() const" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const GdaDictFunction* Gnome::Gda::DictFunction::gobj           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Provides access to the underlying C GObject. 
<p>

<p>
Reimplemented from <a class="el" href="classGnome_1_1Gda_1_1Object.html#df1d2b9394040be2e5a67f9e2b15b252">Gnome::Gda::Object</a>.
</div>
</div><p>
<a class="anchor" name="9869b3c66aa039b269bf04ff782eb0a0"></a><!-- doxytag: member="Gnome::Gda::DictFunction::gobj" ref="9869b3c66aa039b269bf04ff782eb0a0" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">GdaDictFunction* Gnome::Gda::DictFunction::gobj           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Provides access to the underlying C GObject. 
<p>

<p>
Reimplemented from <a class="el" href="classGnome_1_1Gda_1_1Object.html#172549d176d19e80e6a4bee516c472df">Gnome::Gda::Object</a>.
</div>
</div><p>
<a class="anchor" name="5976c360cf3fe0961b39a4f58bf1ed05"></a><!-- doxytag: member="Gnome::Gda::DictFunction::gobj_copy" ref="5976c360cf3fe0961b39a4f58bf1ed05" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">GdaDictFunction* Gnome::Gda::DictFunction::gobj_copy           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. 
<p>

<p>
Reimplemented from <a class="el" href="classGnome_1_1Gda_1_1Object.html#0b2ee60d971b16b74ed9b9c48b1524ef">Gnome::Gda::Object</a>.
</div>
</div><p>
<a class="anchor" name="68cc01342ee35e935fae6687c0d0fbc7"></a><!-- doxytag: member="Gnome::Gda::DictFunction::set_arg_dict_types" ref="68cc01342ee35e935fae6687c0d0fbc7" args="(const Glib::SListHandle&lt; DictType &gt; &amp;arg_types)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Gnome::Gda::DictFunction::set_arg_dict_types           </td>
          <td>(</td>
          <td class="paramtype">const <a class="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1SListHandle.html">Glib::SListHandle</a>&lt;<a class="el" href="classGnome_1_1Gda_1_1DictType.html">DictType</a>&gt;&amp;&nbsp;</td>
          <td class="paramname"> <em>arg_types</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set the arguments types of a function. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>arg_types</em>&nbsp;</td><td>A list of <a class="el" href="classGnome_1_1Gda_1_1DictType.html">Gda::DictType</a> objects or #<code>0</code> values ordered to represent the data types of the function's arguments . </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="c86f780edeae97dae310d28a560360a3"></a><!-- doxytag: member="Gnome::Gda::DictFunction::set_dbms_id" ref="c86f780edeae97dae310d28a560360a3" args="(const Glib::ustring &amp;id)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Gnome::Gda::DictFunction::set_dbms_id           </td>
          <td>(</td>
          <td class="paramtype">const <a class="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>id</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set the DBMS identifier of the function. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>id</em>&nbsp;</td><td>The DBMS identifier. </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="a09305f0a7f76722a69ec732b3d4dd0c"></a><!-- doxytag: member="Gnome::Gda::DictFunction::set_ret_dict_type" ref="a09305f0a7f76722a69ec732b3d4dd0c" args="(const Glib::RefPtr&lt; DictType &gt; &amp;dt)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Gnome::Gda::DictFunction::set_ret_dict_type           </td>
          <td>(</td>
          <td class="paramtype">const <a class="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt;<a class="el" href="classGnome_1_1Gda_1_1DictType.html">DictType</a>&gt;&amp;&nbsp;</td>
          <td class="paramname"> <em>dt</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set the return type of a function. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>dt</em>&nbsp;</td><td>A <a class="el" href="classGnome_1_1Gda_1_1DictType.html">Gda::DictType</a> object or #<code>0</code>. </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="6df9b14310854b5bcf6ffed4429ceae0"></a><!-- doxytag: member="Gnome::Gda::DictFunction::set_sqlname" ref="6df9b14310854b5bcf6ffed4429ceae0" args="(const Glib::ustring &amp;sqlname)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Gnome::Gda::DictFunction::set_sqlname           </td>
          <td>(</td>
          <td class="paramtype">const <a class="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>sqlname</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set the SQL name of the data type. 
<p>

</div>
</div><p>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="a0042e71d194b0b73da26dd93176cfa7"></a><!-- doxytag: member="Gnome::Gda::DictFunction::wrap" ref="a0042e71d194b0b73da26dd93176cfa7" args="(GdaDictFunction *object, bool take_copy=false)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt;<a class="el" href="classGnome_1_1Gda_1_1DictFunction.html">Gnome::Gda::DictFunction</a>&gt; wrap           </td>
          <td>(</td>
          <td class="paramtype">GdaDictFunction *&nbsp;</td>
          <td class="paramname"> <em>object</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>take_copy</em> = <code>false</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [related]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
A <a class="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/namespaceGlib.html#671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>object</em>&nbsp;</td><td>The C instance. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>take_copy</em>&nbsp;</td><td>False if the result should take ownership of the C instance. True if it should take a new copy or ref. </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="dictfunction_8h.html">dictfunction.h</a></ul>
<hr><address><small>
Generated for libgdamm by <a href="http://www.doxygen.org/index.html">
Doxygen</a> 1.5.1 &copy;&nbsp;1997-2001</small></address>
</body>
</html>