libgda-5.0-doc 5.2.2-1 / usr / share / gtk-doc / html / libgda-5.0 / GdaVirtualConnection.html

This file is indexed.

/usr/share/gtk-doc/html/libgda-5.0/GdaVirtualConnection.html is in libgda-5.0-doc 5.2.2-1.

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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GNOME Data Access 5 manual: GdaVirtualConnection</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="GNOME Data Access 5 manual">
<link rel="up" href="virtual_connection.html" title="Virtual connections">
<link rel="prev" href="GdaVproviderHub.html" title="GdaVproviderHub">
<link rel="next" href="GdaVconnectionDataModel.html" title="GdaVconnectionDataModel">
<meta name="generator" content="GTK-Doc V1.20 (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="10"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 
                  <a href="#GdaVirtualConnection.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 
                  <a href="#GdaVirtualConnection.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> 
                  <a href="#GdaVirtualConnection.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="virtual_connection.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GdaVproviderHub.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GdaVconnectionDataModel.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GdaVirtualConnection"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GdaVirtualConnection.top_of_page"></a>GdaVirtualConnection</span></h2>
<p>GdaVirtualConnection — Base class for all virtual connection objects</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GdaVirtualConnection.stability-level"></a><h2>Stability Level</h2>
Stable, unless otherwise indicated
</div>
<div class="refsect1">
<a name="GdaVirtualConnection.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="GdaConnection.html" title="GdaConnection"><span class="returnvalue">GdaConnection</span></a> *
</td>
<td class="function_name">
<a class="link" href="GdaVirtualConnection.html#gda-virtual-connection-open" title="gda_virtual_connection_open ()">gda_virtual_connection_open</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GdaConnection.html" title="GdaConnection"><span class="returnvalue">GdaConnection</span></a> *
</td>
<td class="function_name">
<a class="link" href="GdaVirtualConnection.html#gda-virtual-connection-open-extended" title="gda_virtual_connection_open_extended ()">gda_virtual_connection_open_extended</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GdaVirtualConnection.html#gda-virtual-connection-internal-set-provider-data" title="gda_virtual_connection_internal_set_provider_data ()">gda_virtual_connection_internal_set_provider_data</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a>
</td>
<td class="function_name">
<a class="link" href="GdaVirtualConnection.html#gda-virtual-connection-internal-get-provider-data" title="gda_virtual_connection_internal_get_provider_data ()">gda_virtual_connection_internal_get_provider_data</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GdaVirtualConnection.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GdaVirtualConnection.html#GdaVirtualConnection-struct" title="struct GdaVirtualConnection">GdaVirtualConnection</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GdaVirtualConnection.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
    <span class="lineart">╰──</span> <a class="link" href="GdaConnection.html" title="GdaConnection">GdaConnection</a>
        <span class="lineart">╰──</span> GdaVirtualConnection
            <span class="lineart">╰──</span> <a class="link" href="GdaVconnectionDataModel.html" title="GdaVconnectionDataModel">GdaVconnectionDataModel</a>
</pre>
</div>
<div class="refsect1">
<a name="GdaVirtualConnection.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GdaVirtualConnection implements
 <a class="link" href="GdaLockable.html" title="GdaLockable">GdaLockable</a>.</p>
</div>
<div class="refsect1">
<a name="GdaVirtualConnection.description"></a><h2>Description</h2>
<p>This is a base virtual class for all virtual connection implementations.</p>
</div>
<div class="refsect1">
<a name="GdaVirtualConnection.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gda-virtual-connection-open"></a><h3>gda_virtual_connection_open ()</h3>
<pre class="programlisting"><a class="link" href="GdaConnection.html" title="GdaConnection"><span class="returnvalue">GdaConnection</span></a> *
gda_virtual_connection_open (<em class="parameter"><code><a class="link" href="GdaVirtualProvider.html" title="GdaVirtualProvider"><span class="type">GdaVirtualProvider</span></a> *virtual_provider</code></em>,
                             <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Creates and opens a new virtual connection using the <em class="parameter"><code>virtual_provider</code></em>
 provider. The returned value
is a new <a class="link" href="GdaVirtualConnection.html" title="GdaVirtualConnection"><span class="type">GdaVirtualConnection</span></a> which needs to be used to actually add some contents to the virtual connection.</p>
<div class="refsect3">
<a name="id-1.3.7.6.9.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>virtual_provider</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdaVirtualProvider.html" title="GdaVirtualProvider"><span class="type">GdaVirtualProvider</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a place to store errors, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.7.6.9.2.6"></a><h4>Returns</h4>
<p> a new <a class="link" href="GdaConnection.html" title="GdaConnection"><span class="type">GdaConnection</span></a> object, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if an error occurred</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gda-virtual-connection-open-extended"></a><h3>gda_virtual_connection_open_extended ()</h3>
<pre class="programlisting"><a class="link" href="GdaConnection.html" title="GdaConnection"><span class="returnvalue">GdaConnection</span></a> *
gda_virtual_connection_open_extended (<em class="parameter"><code><a class="link" href="GdaVirtualProvider.html" title="GdaVirtualProvider"><span class="type">GdaVirtualProvider</span></a> *virtual_provider</code></em>,
                                      <em class="parameter"><code><a class="link" href="GdaConnection.html#GdaConnectionOptions" title="enum GdaConnectionOptions"><span class="type">GdaConnectionOptions</span></a> options</code></em>,
                                      <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Creates and opens a new virtual connection using the <em class="parameter"><code>virtual_provider</code></em>
 provider. If <em class="parameter"><code>options</code></em>

contains the <a class="link" href="GdaConnection.html#GDA-CONNECTION-OPTIONS-THREAD-ISOLATED:CAPS"><code class="literal">GDA_CONNECTION_OPTIONS_THREAD_ISOLATED</code></a> flag, then the returned connection will be
a thread wrapped connection, and the actual (wrapped) virtual connection can be obtained through
the "gda-virtual-connection" user property (use <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-get-data"><code class="function">g_object_get_data()</code></a> to get it).</p>
<p>The returned value is a new <a class="link" href="GdaVirtualConnection.html" title="GdaVirtualConnection"><span class="type">GdaVirtualConnection</span></a> which needs to be used to actually add some
contents to the virtual connection.</p>
<div class="refsect3">
<a name="id-1.3.7.6.9.3.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>virtual_provider</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdaVirtualProvider.html" title="GdaVirtualProvider"><span class="type">GdaVirtualProvider</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>options</p></td>
<td class="parameter_description"><p>a set of options to specify the new connection</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a place to store errors, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.7.6.9.3.7"></a><h4>Returns</h4>
<p> a new <a class="link" href="GdaConnection.html" title="GdaConnection"><span class="type">GdaConnection</span></a> object, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if an error occurred</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gda-virtual-connection-internal-set-provider-data"></a><h3>gda_virtual_connection_internal_set_provider_data ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gda_virtual_connection_internal_set_provider_data
                               (<em class="parameter"><code><a class="link" href="GdaVirtualConnection.html" title="GdaVirtualConnection"><span class="type">GdaVirtualConnection</span></a> *vcnc</code></em>,
                                <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>,
                                <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> destroy_func</code></em>);</pre>
<p>Note: calling this function more than once will not make it call <em class="parameter"><code>destroy_func</code></em>
 on any previously
set opaque <em class="parameter"><code>data</code></em>
, you'll have to do it yourself.</p>
<div class="refsect3">
<a name="id-1.3.7.6.9.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>vcnc</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdaConnection.html" title="GdaConnection"><span class="type">GdaConnection</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>an opaque structure, known only to the provider for which <em class="parameter"><code>vcnc</code></em>
is opened</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>destroy_func</p></td>
<td class="parameter_description"><p>function to call when the connection closes and <em class="parameter"><code>data</code></em>
needs to be destroyed</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gda-virtual-connection-internal-get-provider-data"></a><h3>gda_virtual_connection_internal_get_provider_data ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a>
gda_virtual_connection_internal_get_provider_data
                               (<em class="parameter"><code><a class="link" href="GdaVirtualConnection.html" title="GdaVirtualConnection"><span class="type">GdaVirtualConnection</span></a> *vcnc</code></em>);</pre>
<p>Get the opaque pointer previously set using <a class="link" href="GdaVirtualConnection.html#gda-virtual-connection-internal-set-provider-data" title="gda_virtual_connection_internal_set_provider_data ()"><code class="function">gda_virtual_connection_internal_set_provider_data()</code></a>.
If it's not set, then add a connection event and returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p>
<div class="refsect3">
<a name="id-1.3.7.6.9.5.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>vcnc</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdaConnection.html" title="GdaConnection"><span class="type">GdaConnection</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.7.6.9.5.6"></a><h4>Returns</h4>
<p> the pointer to the opaque structure set using <a class="link" href="GdaVirtualConnection.html#gda-virtual-connection-internal-set-provider-data" title="gda_virtual_connection_internal_set_provider_data ()"><code class="function">gda_virtual_connection_internal_set_provider_data()</code></a></p>
<p></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="GdaVirtualConnection.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GdaVirtualConnection-struct"></a><h3>struct GdaVirtualConnection</h3>
<pre class="programlisting">struct GdaVirtualConnection;</pre>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.20</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.