libgda-4.0-doc 4.2.8-2build1 / usr / share / gtk-doc / html / libgda-4.0 / libgda-4.0-Default-Data-handlers.html

This file is indexed.

/usr/share/gtk-doc/html/libgda-4.0/libgda-4.0-Default-Data-handlers.html is in libgda-4.0-doc 4.2.8-2build1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GdaDataHandler</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="GNOME Data Access 4 manual">
<link rel="up" href="data_conv.html" title="Data conversions">
<link rel="prev" href="data_conv.html" title="Data conversions">
<link rel="next" href="GdaHandlerString.html" title="GdaHandlerString">
<meta name="generator" content="GTK-Doc V1.17 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</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="data_conv.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="data_conv.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 4 manual</th>
<td><a accesskey="n" href="GdaHandlerString.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libgda-4.0-Default-Data-handlers.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#libgda-4.0-Default-Data-handlers.description" class="shortcut">Description</a>
                   | 
                  <a href="#libgda-4.0-Default-Data-handlers.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#libgda-4.0-Default-Data-handlers.prerequisites" class="shortcut">Prerequisites</a>
                   | 
                  <a href="#libgda-4.0-Default-Data-handlers.implementations" class="shortcut">Known Implementations</a>
</td></tr>
</table>
<div class="refentry">
<a name="libgda-4.0-Default-Data-handlers"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgda-4.0-Default-Data-handlers.top_of_page"></a>GdaDataHandler</span></h2>
<p>GdaDataHandler — Interface which provides data handling (conversions) capabilities</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libgda-4.0-Default-Data-handlers.synopsis"></a><h2>Synopsis</h2>
<a name="GdaDataHandler"></a><pre class="synopsis">                    <a class="link" href="libgda-4.0-Default-Data-handlers.html#GdaDataHandler-struct" title="GdaDataHandler">GdaDataHandler</a>;
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a class="link" href="libgda-4.0-Default-Data-handlers.html#gda-data-handler-get-sql-from-value" title="gda_data_handler_get_sql_from_value ()">gda_data_handler_get_sql_from_value</a> (<em class="parameter"><code><a class="link" href="libgda-4.0-Default-Data-handlers.html#GdaDataHandler"><span class="type">GdaDataHandler</span></a> *dh</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a class="link" href="libgda-4.0-Default-Data-handlers.html#gda-data-handler-get-str-from-value" title="gda_data_handler_get_str_from_value ()">gda_data_handler_get_str_from_value</a> (<em class="parameter"><code><a class="link" href="libgda-4.0-Default-Data-handlers.html#GdaDataHandler"><span class="type">GdaDataHandler</span></a> *dh</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="returnvalue">GValue</span></a> *            <a class="link" href="libgda-4.0-Default-Data-handlers.html#gda-data-handler-get-value-from-sql" title="gda_data_handler_get_value_from_sql ()">gda_data_handler_get_value_from_sql</a> (<em class="parameter"><code><a class="link" href="libgda-4.0-Default-Data-handlers.html#GdaDataHandler"><span class="type">GdaDataHandler</span></a> *dh</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *sql</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> type</code></em>);
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="returnvalue">GValue</span></a> *            <a class="link" href="libgda-4.0-Default-Data-handlers.html#gda-data-handler-get-value-from-str" title="gda_data_handler_get_value_from_str ()">gda_data_handler_get_value_from_str</a> (<em class="parameter"><code><a class="link" href="libgda-4.0-Default-Data-handlers.html#GdaDataHandler"><span class="type">GdaDataHandler</span></a> *dh</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *str</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> type</code></em>);
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="returnvalue">GValue</span></a> *            <a class="link" href="libgda-4.0-Default-Data-handlers.html#gda-data-handler-get-sane-init-value" title="gda_data_handler_get_sane_init_value ()">gda_data_handler_get_sane_init_value</a>
                                                        (<em class="parameter"><code><a class="link" href="libgda-4.0-Default-Data-handlers.html#GdaDataHandler"><span class="type">GdaDataHandler</span></a> *dh</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> type</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="libgda-4.0-Default-Data-handlers.html#gda-data-handler-accepts-g-type" title="gda_data_handler_accepts_g_type ()">gda_data_handler_accepts_g_type</a>     (<em class="parameter"><code><a class="link" href="libgda-4.0-Default-Data-handlers.html#GdaDataHandler"><span class="type">GdaDataHandler</span></a> *dh</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> type</code></em>);
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="libgda-4.0-Default-Data-handlers.html#gda-data-handler-get-descr" title="gda_data_handler_get_descr ()">gda_data_handler_get_descr</a>          (<em class="parameter"><code><a class="link" href="libgda-4.0-Default-Data-handlers.html#GdaDataHandler"><span class="type">GdaDataHandler</span></a> *dh</code></em>);

<a class="link" href="libgda-4.0-Default-Data-handlers.html#GdaDataHandler"><span class="returnvalue">GdaDataHandler</span></a> *    <a class="link" href="libgda-4.0-Default-Data-handlers.html#gda-data-handler-get-default" title="gda_data_handler_get_default ()">gda_data_handler_get_default</a>        (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> for_type</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libgda-4.0-Default-Data-handlers.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  GInterface
   +----GdaDataHandler
</pre>
</div>
<div class="refsect1">
<a name="libgda-4.0-Default-Data-handlers.prerequisites"></a><h2>Prerequisites</h2>
<p>
GdaDataHandler requires
 <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>.</p>
</div>
<div class="refsect1">
<a name="libgda-4.0-Default-Data-handlers.implementations"></a><h2>Known Implementations</h2>
<p>
GdaDataHandler is implemented by
 <a class="link" href="GdaHandlerBin.html" title="GdaHandlerBin">GdaHandlerBin</a>,  <a class="link" href="GdaHandlerBoolean.html" title="GdaHandlerBoolean">GdaHandlerBoolean</a>,  <a class="link" href="GdaHandlerNumerical.html" title="GdaHandlerNumerical">GdaHandlerNumerical</a>,  <a class="link" href="GdaHandlerString.html" title="GdaHandlerString">GdaHandlerString</a>,  <a class="link" href="GdaHandlerTime.html" title="GdaHandlerTime">GdaHandlerTime</a> and  <a class="link" href="GdaHandlerType.html" title="GdaHandlerType">GdaHandlerType</a>.</p>
</div>
<div class="refsect1">
<a name="libgda-4.0-Default-Data-handlers.description"></a><h2>Description</h2>
<p>
  Because data types vary a lot from a DBMS to another, the <a class="link" href="libgda-4.0-Default-Data-handlers.html#GdaDataHandler"><span class="type">GdaDataHandler</span></a> interface helps
  managing data in its various representations, and converting from one to another:
  </p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem"><p>as a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> which is a generic value container for the C language</p></li>
<li class="listitem"><p>as a human readable string</p></li>
<li class="listitem"><p>as an SQL string (a string which can be used in SQL statements)</p></li>
</ul></div>
<p>
</p>
<p>
  For each data type, a corresponding <a class="link" href="libgda-4.0-Default-Data-handlers.html#GdaDataHandler"><span class="type">GdaDataHandler</span></a> object can be requested using the
  <a class="link" href="libgda-4.0-Default-Data-handlers.html#gda-data-handler-get-default" title="gda_data_handler_get_default ()"><a class="link" href="libgda-4.0-Default-Data-handlers.html#gda-data-handler-get-default" title="gda_data_handler_get_default ()"><code class="function">gda_data_handler_get_default()</code></a></a> function. However, when working
  with a specific database provider, it's better to use a <a class="link" href="libgda-4.0-Default-Data-handlers.html#GdaDataHandler"><span class="type">GdaDataHandler</span></a> which may be specific to the
  database provider which will correctly handle each database specifics using
  <a class="link" href="GdaServerProvider.html#gda-server-provider-get-data-handler-g-type" title="gda_server_provider_get_data_handler_g_type ()"><a class="link" href="GdaServerProvider.html#gda-server-provider-get-data-handler-g-type" title="gda_server_provider_get_data_handler_g_type ()"><code class="function">gda_server_provider_get_data_handler_g_type()</code></a></a> or
  <a class="link" href="GdaServerProvider.html#gda-server-provider-get-data-handler-dbms" title="gda_server_provider_get_data_handler_dbms ()"><a class="link" href="GdaServerProvider.html#gda-server-provider-get-data-handler-dbms" title="gda_server_provider_get_data_handler_dbms ()"><code class="function">gda_server_provider_get_data_handler_dbms()</code></a></a>.
</p>
</div>
<div class="refsect1">
<a name="libgda-4.0-Default-Data-handlers.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GdaDataHandler-struct"></a><h3>GdaDataHandler</h3>
<pre class="programlisting">typedef struct _GdaDataHandler GdaDataHandler;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gda-data-handler-get-sql-from-value"></a><h3>gda_data_handler_get_sql_from_value ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             gda_data_handler_get_sql_from_value (<em class="parameter"><code><a class="link" href="libgda-4.0-Default-Data-handlers.html#GdaDataHandler"><span class="type">GdaDataHandler</span></a> *dh</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);</pre>
<p>
Creates a new string which is an SQL representation of the given value, the returned string
can be used directly in an SQL statement. For example if <em class="parameter"><code>value</code></em> is a G_TYPE_STRING, then
the returned string will be correctly quoted. Note however that it is a better practice
to use variables in statements instead of value literals, see
the <a class="link" href="GdaSqlParser.html#GdaSqlParser.description" title="Description">GdaSqlParser</a> for more information.
</p>
<p>
If the value is NULL or is of type GDA_TYPE_NULL,
or is a G_TYPE_STRING and <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Standard-Parameter-and-Value-Types.html#g-value-get-string"><code class="function">g_value_get_string()</code></a> returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the returned string is "NULL".
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>dh</code></em> :</span></p></td>
<td>an object which implements the <a class="link" href="libgda-4.0-Default-Data-handlers.html#GdaDataHandler"><span class="type">GdaDataHandler</span></a> interface</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>the value to be converted to a string</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the new string, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if an error occurred. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-data-handler-get-str-from-value"></a><h3>gda_data_handler_get_str_from_value ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             gda_data_handler_get_str_from_value (<em class="parameter"><code><a class="link" href="libgda-4.0-Default-Data-handlers.html#GdaDataHandler"><span class="type">GdaDataHandler</span></a> *dh</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);</pre>
<p>
Creates a new string which is a "user friendly" representation of the given value
(in the user's locale, specially for the dates). If the value is 
NULL or is of type GDA_TYPE_NULL, the returned string is a copy of "" (empty string).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>dh</code></em> :</span></p></td>
<td>an object which implements the <a class="link" href="libgda-4.0-Default-Data-handlers.html#GdaDataHandler"><span class="type">GdaDataHandler</span></a> interface</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>the value to be converted to a string</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the new string, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if an error occurred. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-data-handler-get-value-from-sql"></a><h3>gda_data_handler_get_value_from_sql ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="returnvalue">GValue</span></a> *            gda_data_handler_get_value_from_sql (<em class="parameter"><code><a class="link" href="libgda-4.0-Default-Data-handlers.html#GdaDataHandler"><span class="type">GdaDataHandler</span></a> *dh</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *sql</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> type</code></em>);</pre>
<p>
Creates a new GValue which represents the SQL value given as argument. This is
the opposite of the function <a class="link" href="libgda-4.0-Default-Data-handlers.html#gda-data-handler-get-sql-from-value" title="gda_data_handler_get_sql_from_value ()"><code class="function">gda_data_handler_get_sql_from_value()</code></a>. The type argument
is used to determine the real data type requested for the returned value.
</p>
<p>
If the <em class="parameter"><code>sql</code></em> string is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, then the returned GValue is of type GDA_TYPE_NULL;
if the <em class="parameter"><code>sql</code></em> string does not correspond to a valid SQL string for the requested type, then
the <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> is returned.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>dh</code></em> :</span></p></td>
<td>an object which implements the <a class="link" href="libgda-4.0-Default-Data-handlers.html#GdaDataHandler"><span class="type">GdaDataHandler</span></a> interface</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>sql</code></em> :</span></p></td>
<td>an SQL string</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>a GType</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the new <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-data-handler-get-value-from-str"></a><h3>gda_data_handler_get_value_from_str ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="returnvalue">GValue</span></a> *            gda_data_handler_get_value_from_str (<em class="parameter"><code><a class="link" href="libgda-4.0-Default-Data-handlers.html#GdaDataHandler"><span class="type">GdaDataHandler</span></a> *dh</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *str</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> type</code></em>);</pre>
<p>
Creates a new GValue which represents the <em class="parameter"><code>str</code></em> value given as argument. This is
the opposite of the function <a class="link" href="libgda-4.0-Default-Data-handlers.html#gda-data-handler-get-str-from-value" title="gda_data_handler_get_str_from_value ()"><code class="function">gda_data_handler_get_str_from_value()</code></a>. The type argument
is used to determine the real data type requested for the returned value.
</p>
<p>
If the <em class="parameter"><code>str</code></em> string is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, then the returned GValue is of type GDA_TYPE_NULL;
if the <em class="parameter"><code>str</code></em> string does not correspond to a valid string for the requested type, then
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> is returned.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>dh</code></em> :</span></p></td>
<td>an object which implements the <a class="link" href="libgda-4.0-Default-Data-handlers.html#GdaDataHandler"><span class="type">GdaDataHandler</span></a> interface</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td>
<td>a string</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>a GType</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the new <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-data-handler-get-sane-init-value"></a><h3>gda_data_handler_get_sane_init_value ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="returnvalue">GValue</span></a> *            gda_data_handler_get_sane_init_value
                                                        (<em class="parameter"><code><a class="link" href="libgda-4.0-Default-Data-handlers.html#GdaDataHandler"><span class="type">GdaDataHandler</span></a> *dh</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> type</code></em>);</pre>
<p>
Creates a new GValue which holds a sane initial value to be used if no value is specifically
provided. For example for a simple string, this would return a new value containing the "" string.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>dh</code></em> :</span></p></td>
<td>an object which implements the <a class="link" href="libgda-4.0-Default-Data-handlers.html#GdaDataHandler"><span class="type">GdaDataHandler</span></a> interface</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the new <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if no such value can be created. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-data-handler-accepts-g-type"></a><h3>gda_data_handler_accepts_g_type ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gda_data_handler_accepts_g_type     (<em class="parameter"><code><a class="link" href="libgda-4.0-Default-Data-handlers.html#GdaDataHandler"><span class="type">GdaDataHandler</span></a> *dh</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> type</code></em>);</pre>
<p>
Checks wether the GdaDataHandler is able to handle the gda type given as argument.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>dh</code></em> :</span></p></td>
<td>an object which implements the <a class="link" href="libgda-4.0-Default-Data-handlers.html#GdaDataHandler"><span class="type">GdaDataHandler</span></a> interface</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the gda type can be handled</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-data-handler-get-descr"></a><h3>gda_data_handler_get_descr ()</h3>
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       gda_data_handler_get_descr          (<em class="parameter"><code><a class="link" href="libgda-4.0-Default-Data-handlers.html#GdaDataHandler"><span class="type">GdaDataHandler</span></a> *dh</code></em>);</pre>
<p>
Get a short description of the GdaDataHandler
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>dh</code></em> :</span></p></td>
<td>an object which implements the <a class="link" href="libgda-4.0-Default-Data-handlers.html#GdaDataHandler"><span class="type">GdaDataHandler</span></a> interface</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the description. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-data-handler-get-default"></a><h3>gda_data_handler_get_default ()</h3>
<pre class="programlisting"><a class="link" href="libgda-4.0-Default-Data-handlers.html#GdaDataHandler"><span class="returnvalue">GdaDataHandler</span></a> *    gda_data_handler_get_default        (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> for_type</code></em>);</pre>
<p>
Obtain a pointer to a <a class="link" href="libgda-4.0-Default-Data-handlers.html#GdaDataHandler"><span class="type">GdaDataHandler</span></a> which can manage <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> values of type <em class="parameter"><code>for_type</code></em>. The returned
data handler will be adapted to use the current locale information (for example dates will be formatted
taking into account the locale).
</p>
<p>
The returned pointer is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if there is no default data handler available for the <em class="parameter"><code>for_type</code></em> data type
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>for_type</code></em> :</span></p></td>
<td>a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> type</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <a class="link" href="libgda-4.0-Default-Data-handlers.html#GdaDataHandler"><span class="type">GdaDataHandler</span></a> which must not be modified or destroyed. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 4.2.3</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.17</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.