/usr/share/gtk-doc/html/libgda-4.0/GdaBatch.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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GdaBatch</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="connection.html" title="Connections & commands">
<link rel="prev" href="libgda-4.0-GdaRepetitiveStatement.html" title="GdaRepetitiveStatement">
<link rel="next" href="GdaHolder.html" title="GdaHolder">
<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="libgda-4.0-GdaRepetitiveStatement.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="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="GdaHolder.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GdaBatch.synopsis" class="shortcut">Top</a>
|
<a href="#GdaBatch.description" class="shortcut">Description</a>
|
<a href="#GdaBatch.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GdaBatch.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="GdaBatch"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GdaBatch.top_of_page"></a>GdaBatch</span></h2>
<p>GdaBatch — Multiple SQL statements grouped together.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GdaBatch.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"> <a class="link" href="GdaBatch.html#GdaBatch-struct" title="GdaBatch">GdaBatch</a>;
enum <a class="link" href="GdaBatch.html#GdaBatchError" title="enum GdaBatchError">GdaBatchError</a>;
<a class="link" href="GdaBatch.html" title="GdaBatch"><span class="returnvalue">GdaBatch</span></a> * <a class="link" href="GdaBatch.html#gda-batch-new" title="gda_batch_new ()">gda_batch_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a class="link" href="GdaBatch.html" title="GdaBatch"><span class="returnvalue">GdaBatch</span></a> * <a class="link" href="GdaBatch.html#gda-batch-copy" title="gda_batch_copy ()">gda_batch_copy</a> (<em class="parameter"><code><a class="link" href="GdaBatch.html" title="GdaBatch"><span class="type">GdaBatch</span></a> *orig</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GdaBatch.html#gda-batch-add-statement" title="gda_batch_add_statement ()">gda_batch_add_statement</a> (<em class="parameter"><code><a class="link" href="GdaBatch.html" title="GdaBatch"><span class="type">GdaBatch</span></a> *batch</code></em>,
<em class="parameter"><code><a class="link" href="GdaStatement.html" title="GdaStatement"><span class="type">GdaStatement</span></a> *stmt</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GdaBatch.html#gda-batch-remove-statement" title="gda_batch_remove_statement ()">gda_batch_remove_statement</a> (<em class="parameter"><code><a class="link" href="GdaBatch.html" title="GdaBatch"><span class="type">GdaBatch</span></a> *batch</code></em>,
<em class="parameter"><code><a class="link" href="GdaStatement.html" title="GdaStatement"><span class="type">GdaStatement</span></a> *stmt</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="GdaBatch.html#gda-batch-serialize" title="gda_batch_serialize ()">gda_batch_serialize</a> (<em class="parameter"><code><a class="link" href="GdaBatch.html" title="GdaBatch"><span class="type">GdaBatch</span></a> *batch</code></em>);
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> * <a class="link" href="GdaBatch.html#gda-batch-get-statements" title="gda_batch_get_statements ()">gda_batch_get_statements</a> (<em class="parameter"><code><a class="link" href="GdaBatch.html" title="GdaBatch"><span class="type">GdaBatch</span></a> *batch</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="GdaBatch.html#gda-batch-get-parameters" title="gda_batch_get_parameters ()">gda_batch_get_parameters</a> (<em class="parameter"><code><a class="link" href="GdaBatch.html" title="GdaBatch"><span class="type">GdaBatch</span></a> *batch</code></em>,
<em class="parameter"><code><a class="link" href="GdaSet.html" title="GdaSet"><span class="type">GdaSet</span></a> **out_params</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>
</div>
<div class="refsect1">
<a name="GdaBatch.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>
+----GdaBatch
</pre>
</div>
<div class="refsect1">
<a name="GdaBatch.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="GdaBatch.html#GdaBatch-changed" title='The "changed" signal'>changed</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a>
</pre>
</div>
<div class="refsect1">
<a name="GdaBatch.description"></a><h2>Description</h2>
<p>
The <a class="link" href="GdaBatch.html" title="GdaBatch"><span class="type">GdaBatch</span></a> object represents one or more SQL statements (as <a class="link" href="GdaStatement.html" title="GdaStatement"><span class="type">GdaStatement</span></a> objects) in a single object.
</p>
<p>
A <a class="link" href="GdaBatch.html" title="GdaBatch"><span class="type">GdaBatch</span></a> can either be built "manually" by assembling together several <a class="link" href="GdaStatement.html" title="GdaStatement"><span class="type">GdaStatement</span></a> objects, or from an SQL string using
a <a class="link" href="GdaSqlParser.html" title="GdaSqlParser"><span class="type">GdaSqlParser</span></a> object.
</p>
</div>
<div class="refsect1">
<a name="GdaBatch.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GdaBatch-struct"></a><h3>GdaBatch</h3>
<pre class="programlisting">typedef struct _GdaBatch GdaBatch;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="GdaBatchError"></a><h3>enum GdaBatchError</h3>
<pre class="programlisting">typedef enum {
GDA_BATCH_CONFLICTING_PARAMETER_ERROR
} GdaBatchError;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gda-batch-new"></a><h3>gda_batch_new ()</h3>
<pre class="programlisting"><a class="link" href="GdaBatch.html" title="GdaBatch"><span class="returnvalue">GdaBatch</span></a> * gda_batch_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Creates a new <a class="link" href="GdaBatch.html" title="GdaBatch"><span class="type">GdaBatch</span></a> object
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the new object</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-batch-copy"></a><h3>gda_batch_copy ()</h3>
<pre class="programlisting"><a class="link" href="GdaBatch.html" title="GdaBatch"><span class="returnvalue">GdaBatch</span></a> * gda_batch_copy (<em class="parameter"><code><a class="link" href="GdaBatch.html" title="GdaBatch"><span class="type">GdaBatch</span></a> *orig</code></em>);</pre>
<p>
Copy constructor
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>orig</code></em> :</span></p></td>
<td>a <a class="link" href="GdaBatch.html" title="GdaBatch"><span class="type">GdaBatch</span></a> to make a copy of</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a the new copy of <em class="parameter"><code>orig</code></em>. <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-batch-add-statement"></a><h3>gda_batch_add_statement ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gda_batch_add_statement (<em class="parameter"><code><a class="link" href="GdaBatch.html" title="GdaBatch"><span class="type">GdaBatch</span></a> *batch</code></em>,
<em class="parameter"><code><a class="link" href="GdaStatement.html" title="GdaStatement"><span class="type">GdaStatement</span></a> *stmt</code></em>);</pre>
<p>
Add <em class="parameter"><code>stmt</code></em> to the list of statements managed by <em class="parameter"><code>batch</code></em>. A <a class="link" href="GdaStatement.html" title="GdaStatement"><span class="type">GdaStatement</span></a> object can be
added multiple times to a <a class="link" href="GdaBatch.html" title="GdaBatch"><span class="type">GdaBatch</span></a> object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>batch</code></em> :</span></p></td>
<td>a <a class="link" href="GdaBatch.html" title="GdaBatch"><span class="type">GdaBatch</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>stmt</code></em> :</span></p></td>
<td>a statement to add to <em class="parameter"><code>batch</code></em>'s statements list</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-batch-remove-statement"></a><h3>gda_batch_remove_statement ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gda_batch_remove_statement (<em class="parameter"><code><a class="link" href="GdaBatch.html" title="GdaBatch"><span class="type">GdaBatch</span></a> *batch</code></em>,
<em class="parameter"><code><a class="link" href="GdaStatement.html" title="GdaStatement"><span class="type">GdaStatement</span></a> *stmt</code></em>);</pre>
<p>
Removes <em class="parameter"><code>stmt</code></em> from the list of statements managed by <em class="parameter"><code>batch</code></em>. If <em class="parameter"><code>stmt</code></em> is present several
times in <em class="parameter"><code>batch</code></em>'s statements' list, then only the first one is removed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>batch</code></em> :</span></p></td>
<td>a <a class="link" href="GdaBatch.html" title="GdaBatch"><span class="type">GdaBatch</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>stmt</code></em> :</span></p></td>
<td>a statement to remove from <em class="parameter"><code>batch</code></em>'s statements list</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-batch-serialize"></a><h3>gda_batch_serialize ()</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_batch_serialize (<em class="parameter"><code><a class="link" href="GdaBatch.html" title="GdaBatch"><span class="type">GdaBatch</span></a> *batch</code></em>);</pre>
<p>
Creates a string representing the contents of <em class="parameter"><code>batch</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>batch</code></em> :</span></p></td>
<td>a <a class="link" href="GdaBatch.html" title="GdaBatch"><span class="type">GdaBatch</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a string containing the serialized version of <em class="parameter"><code>batch</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-batch-get-statements"></a><h3>gda_batch_get_statements ()</h3>
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> * gda_batch_get_statements (<em class="parameter"><code><a class="link" href="GdaBatch.html" title="GdaBatch"><span class="type">GdaBatch</span></a> *batch</code></em>);</pre>
<p>
Get a list of the <a class="link" href="GdaStatement.html" title="GdaStatement"><span class="type">GdaStatement</span></a> objects contained in <em class="parameter"><code>batch</code></em>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>batch</code></em> :</span></p></td>
<td>a <a class="link" href="GdaBatch.html" title="GdaBatch"><span class="type">GdaBatch</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a list of <a class="link" href="GdaStatement.html" title="GdaStatement"><span class="type">GdaStatement</span></a> which should not be modified. <span class="annotation">[<a href="http://foldoc.org/element-type"><span class="acronym">element-type</span></a> GdaStatement][<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-batch-get-parameters"></a><h3>gda_batch_get_parameters ()</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_batch_get_parameters (<em class="parameter"><code><a class="link" href="GdaBatch.html" title="GdaBatch"><span class="type">GdaBatch</span></a> *batch</code></em>,
<em class="parameter"><code><a class="link" href="GdaSet.html" title="GdaSet"><span class="type">GdaSet</span></a> **out_params</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>
Get a new <a class="link" href="GdaSet.html" title="GdaSet"><span class="type">GdaSet</span></a> object which groups all the execution parameters
which <em class="parameter"><code>batch</code></em> needs for all the statements it includes.
This new object is returned though <em class="parameter"><code>out_params</code></em>.
</p>
<p>
Note that if <em class="parameter"><code>batch</code></em> does not need any parameter, then <em class="parameter"><code>out_params</code></em> is set to <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>batch</code></em> :</span></p></td>
<td>a <a class="link" href="GdaBatch.html" title="GdaBatch"><span class="type">GdaBatch</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>out_params</code></em> :</span></p></td>
<td>a place to store a new <a class="link" href="GdaSet.html" title="GdaSet"><span class="type">GdaSet</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>. <span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>][<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>][<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
</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>TRUE if no error occurred.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="GdaBatch.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="GdaBatch-changed"></a><h3>The <code class="literal">"changed"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="GdaBatch.html" title="GdaBatch"><span class="type">GdaBatch</span></a> *batch,
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *changed_stmt,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a></pre>
<p>
Gets emitted whenever a <a class="link" href="GdaStatement.html" title="GdaStatement"><span class="type">GdaStatement</span></a> in the <em class="parameter"><code>batch</code></em> object changes
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>batch</code></em> :</span></p></td>
<td>the <a class="link" href="GdaBatch.html" title="GdaBatch"><span class="type">GdaBatch</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>changed_stmt</code></em> :</span></p></td>
<td>the statement which has been changed</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="GdaBatch.see-also"></a><h2>See Also</h2>
<p>
<a class="link" href="GdaStatement.html" title="GdaStatement"><span class="type">GdaStatement</span></a>
</p>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.17</div>
</body>
</html>
|