/usr/share/gtk-doc/html/libgda-4.0/GdaVirtualConnection.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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GdaVirtualConnection</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="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.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="GdaVproviderHub.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="virtual_connection.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="GdaVconnectionDataModel.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GdaVirtualConnection.synopsis" class="shortcut">Top</a>
|
<a href="#GdaVirtualConnection.description" class="shortcut">Description</a>
|
<a href="#GdaVirtualConnection.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GdaVirtualConnection.implemented-interfaces" class="shortcut">Implemented Interfaces</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 valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GdaVirtualConnection.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="GdaVirtualConnection.html#GdaVirtualConnection-struct" title="struct GdaVirtualConnection">GdaVirtualConnection</a>;
<a class="link" href="GdaConnection.html" title="GdaConnection"><span class="returnvalue">GdaConnection</span></a> * <a class="link" href="GdaVirtualConnection.html#gda-virtual-connection-open" title="gda_virtual_connection_open ()">gda_virtual_connection_open</a> (<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="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a class="link" href="GdaConnection.html" title="GdaConnection"><span class="returnvalue">GdaConnection</span></a> * <a class="link" href="GdaVirtualConnection.html#gda-virtual-connection-open-extended" title="gda_virtual_connection_open_extended ()">gda_virtual_connection_open_extended</a>
(<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="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<span class="returnvalue">void</span> <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>
(<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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> destroy_func</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a> <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>
(<em class="parameter"><code><a class="link" href="GdaVirtualConnection.html" title="GdaVirtualConnection"><span class="type">GdaVirtualConnection</span></a> *vcnc</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GdaVirtualConnection.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----<a class="link" href="GdaConnection.html" title="GdaConnection">GdaConnection</a>
+----GdaVirtualConnection
+----<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.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GdaVirtualConnection-struct"></a><h3>struct GdaVirtualConnection</h3>
<pre class="programlisting">struct GdaVirtualConnection;</pre>
<p>
</p>
</div>
<hr>
<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="http://library.gnome.org/devel/glib/unstable/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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>virtual_provider</code></em> :</span></p></td>
<td>a <a class="link" href="GdaVirtualProvider.html" title="GdaVirtualProvider"><span class="type">GdaVirtualProvider</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>a place to store errors, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="GdaConnection.html" title="GdaConnection"><span class="type">GdaConnection</span></a> object, 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</td>
</tr>
</tbody>
</table></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="http://library.gnome.org/devel/glib/unstable/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="http://library.gnome.org/devel/gobject/unstable/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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>virtual_provider</code></em> :</span></p></td>
<td>a <a class="link" href="GdaVirtualProvider.html" title="GdaVirtualProvider"><span class="type">GdaVirtualProvider</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>options</code></em> :</span></p></td>
<td>a set of options to specify the new connection</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>a place to store errors, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="GdaConnection.html" title="GdaConnection"><span class="type">GdaConnection</span></a> object, 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</td>
</tr>
</tbody>
</table></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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>vcnc</code></em> :</span></p></td>
<td>a <a class="link" href="GdaConnection.html" title="GdaConnection"><span class="type">GdaConnection</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>an opaque structure, known only to the provider for which <em class="parameter"><code>vcnc</code></em> is opened</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>destroy_func</code></em> :</span></p></td>
<td>function to call when the connection closes and <em class="parameter"><code>data</code></em> needs to be destroyed</td>
</tr>
</tbody>
</table></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="http://library.gnome.org/devel/glib/unstable/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="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>vcnc</code></em> :</span></p></td>
<td>a <a class="link" href="GdaConnection.html" title="GdaConnection"><span class="type">GdaConnection</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>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>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.17</div>
</body>
</html>
|