/usr/share/gtk-doc/html/libgda-5.0/libgda-5.0-GdaRepetitiveStatement.html is in libgda-5.0-doc 5.2.4-3.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GdaRepetitiveStatement: GNOME Data Access 5 manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GNOME Data Access 5 manual">
<link rel="up" href="connection.html" title="Connections & commands">
<link rel="prev" href="GdaStatement.html" title="GdaStatement">
<link rel="next" href="GdaBatch.html" title="GdaBatch">
<meta name="generator" content="GTK-Doc V1.25 (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="5"><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="#libgda-5.0-GdaRepetitiveStatement.description" class="shortcut">Description</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="connection.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GdaStatement.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GdaBatch.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libgda-5.0-GdaRepetitiveStatement"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgda-5.0-GdaRepetitiveStatement.top_of_page"></a>GdaRepetitiveStatement</span></h2>
<p>GdaRepetitiveStatement — Execute the same statement several times with different values</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libgda-5.0-GdaRepetitiveStatement.stability-level"></a><h2>Stability Level</h2>
<a href="http://foldoc.org/Stable"><span class="acronym">Stable</span></a>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="libgda-5.0-GdaRepetitiveStatement.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" 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="libgda-5.0-GdaRepetitiveStatement.html#GdaRepetitiveStatement" title="GdaRepetitiveStatement"><span class="returnvalue">GdaRepetitiveStatement</span></a> *
</td>
<td class="function_name">
<a class="link" href="libgda-5.0-GdaRepetitiveStatement.html#gda-repetitive-statement-new" title="gda_repetitive_statement_new ()">gda_repetitive_statement_new</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#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="libgda-5.0-GdaRepetitiveStatement.html#gda-repetitive-statement-get-template-set" title="gda_repetitive_statement_get_template_set ()">gda_repetitive_statement_get_template_set</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *
</td>
<td class="function_name">
<a class="link" href="libgda-5.0-GdaRepetitiveStatement.html#gda-repetitive-statement-get-all-sets" title="gda_repetitive_statement_get_all_sets ()">gda_repetitive_statement_get_all_sets</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#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="libgda-5.0-GdaRepetitiveStatement.html#gda-repetitive-statement-append-set" title="gda_repetitive_statement_append_set ()">gda_repetitive_statement_append_set</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libgda-5.0-GdaRepetitiveStatement.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="libgda-5.0-GdaRepetitiveStatement.html#GdaRepetitiveStatement" title="GdaRepetitiveStatement">GdaRepetitiveStatement</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libgda-5.0-GdaRepetitiveStatement.description"></a><h2>Description</h2>
<p>The <a class="link" href="libgda-5.0-GdaRepetitiveStatement.html#GdaRepetitiveStatement" title="GdaRepetitiveStatement"><span class="type">GdaRepetitiveStatement</span></a> object allows one to specify a statement to be executed
several times using different variables' values sets for each execution. Using the object
has almost no interrest at all if the statement to be executed several times has no parameter.</p>
<p>Use the <a class="link" href="GdaConnection.html#gda-connection-repetitive-statement-execute" title="gda_connection_repetitive_statement_execute ()"><code class="function">gda_connection_repetitive_statement_execute()</code></a> method to execute the repetitive statement.</p>
</div>
<div class="refsect1">
<a name="libgda-5.0-GdaRepetitiveStatement.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gda-repetitive-statement-new"></a><h3>gda_repetitive_statement_new ()</h3>
<pre class="programlisting"><a class="link" href="libgda-5.0-GdaRepetitiveStatement.html#GdaRepetitiveStatement" title="GdaRepetitiveStatement"><span class="returnvalue">GdaRepetitiveStatement</span></a> *
gda_repetitive_statement_new (<em class="parameter"><code><a class="link" href="GdaStatement.html" title="GdaStatement"><span class="type">GdaStatement</span></a> *stmt</code></em>);</pre>
<p>Creates a new <a class="link" href="libgda-5.0-GdaRepetitiveStatement.html#GdaRepetitiveStatement" title="GdaRepetitiveStatement"><span class="type">GdaRepetitiveStatement</span></a> object which, when executed, will execute <em class="parameter"><code>stmt</code></em>
once for all
the values set which will have been defined using <a class="link" href="libgda-5.0-GdaRepetitiveStatement.html#gda-repetitive-statement-append-set" title="gda_repetitive_statement_append_set ()"><code class="function">gda_repetitive_statement_append_set()</code></a>.
Use <a class="link" href="GdaConnection.html#gda-connection-repetitive-statement-execute" title="gda_connection_repetitive_statement_execute ()"><code class="function">gda_connection_repetitive_statement_execute()</code></a> to actually execute it.</p>
<div class="refsect3">
<a name="gda-repetitive-statement-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>stmt</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdaStatement.html" title="GdaStatement"><span class="type">GdaStatement</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gda-repetitive-statement-new.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="libgda-5.0-GdaRepetitiveStatement.html#GdaRepetitiveStatement" title="GdaRepetitiveStatement"><span class="type">GdaRepetitiveStatement</span></a> object</p>
</div>
<p class="since">Since: 4.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gda-repetitive-statement-get-template-set"></a><h3>gda_repetitive_statement_get_template_set ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gda_repetitive_statement_get_template_set
(<em class="parameter"><code><a class="link" href="libgda-5.0-GdaRepetitiveStatement.html#GdaRepetitiveStatement" title="GdaRepetitiveStatement"><span class="type">GdaRepetitiveStatement</span></a> *rstmt</code></em>,
<em class="parameter"><code><a class="link" href="GdaSet.html" title="GdaSet"><span class="type">GdaSet</span></a> **set</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>Gets a new <a class="link" href="GdaSet.html" title="GdaSet"><span class="type">GdaSet</span></a> object with the parameters used by the template statement in the
<em class="parameter"><code>rstmt</code></em>
object. </p>
<p>Use this object with <a class="link" href="libgda-5.0-GdaRepetitiveStatement.html#gda-repetitive-statement-append-set" title="gda_repetitive_statement_append_set ()"><code class="function">gda_repetitive_statement_append_set()</code></a>.</p>
<div class="refsect3">
<a name="gda-repetitive-statement-get-template-set.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>rstmt</p></td>
<td class="parameter_description"><p>a <a class="link" href="libgda-5.0-GdaRepetitiveStatement.html#GdaRepetitiveStatement" title="GdaRepetitiveStatement"><span class="type">GdaRepetitiveStatement</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>set</p></td>
<td class="parameter_description"><p>a place to store the returned template set</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 error, 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"><span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gda-repetitive-statement-get-template-set.returns"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on error</p>
</div>
<p class="since">Since: 4.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gda-repetitive-statement-get-all-sets"></a><h3>gda_repetitive_statement_get_all_sets ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *
gda_repetitive_statement_get_all_sets (<em class="parameter"><code><a class="link" href="libgda-5.0-GdaRepetitiveStatement.html#GdaRepetitiveStatement" title="GdaRepetitiveStatement"><span class="type">GdaRepetitiveStatement</span></a> *rstmt</code></em>);</pre>
<p>Get all the values sets which will have been added using <a class="link" href="libgda-5.0-GdaRepetitiveStatement.html#gda-repetitive-statement-append-set" title="gda_repetitive_statement_append_set ()"><code class="function">gda_repetitive_statement_append_set()</code></a>.</p>
<div class="refsect3">
<a name="gda-repetitive-statement-get-all-sets.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>rstmt</p></td>
<td class="parameter_description"><p>a <a class="link" href="libgda-5.0-GdaRepetitiveStatement.html#GdaRepetitiveStatement" title="GdaRepetitiveStatement"><span class="type">GdaRepetitiveStatement</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gda-repetitive-statement-get-all-sets.returns"></a><h4>Returns</h4>
<p> a new <a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> of <a class="link" href="GdaSet.html" title="GdaSet"><span class="type">GdaSet</span></a> objects (free with <a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#g-slist-free"><code class="function">g_slist_free()</code></a>). </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20container"><span class="acronym">transfer container</span></a>][<a href="http://foldoc.org/element-type"><span class="acronym">element-type</span></a> GdaSet]</span></p>
</div>
<p class="since">Since: 4.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gda-repetitive-statement-append-set"></a><h3>gda_repetitive_statement_append_set ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gda_repetitive_statement_append_set (<em class="parameter"><code><a class="link" href="libgda-5.0-GdaRepetitiveStatement.html#GdaRepetitiveStatement" title="GdaRepetitiveStatement"><span class="type">GdaRepetitiveStatement</span></a> *rstmt</code></em>,
<em class="parameter"><code><a class="link" href="GdaSet.html" title="GdaSet"><span class="type">GdaSet</span></a> *values</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> make_copy</code></em>);</pre>
<p>Specifies that <em class="parameter"><code>rstmt</code></em>
be executed one time with the values contained in <em class="parameter"><code>values</code></em>
. </p>
<p>A new <a class="link" href="GdaSet.html" title="GdaSet"><span class="type">GdaSet</span></a> to be used as the <em class="parameter"><code>values</code></em>
argument can be obtained using
<a class="link" href="libgda-5.0-GdaRepetitiveStatement.html#gda-repetitive-statement-get-template-set" title="gda_repetitive_statement_get_template_set ()"><code class="function">gda_repetitive_statement_get_template_set()</code></a>.</p>
<div class="refsect3">
<a name="gda-repetitive-statement-append-set.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>rstmt</p></td>
<td class="parameter_description"><p>a <a class="link" href="libgda-5.0-GdaRepetitiveStatement.html#GdaRepetitiveStatement" title="GdaRepetitiveStatement"><span class="type">GdaRepetitiveStatement</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>values</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdaSet.html" title="GdaSet"><span class="type">GdaSet</span></a> object with the values to be used</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>make_copy</p></td>
<td class="parameter_description"><p><a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>values</code></em>
is copied, and <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if <em class="parameter"><code>values</code></em>
is only ref'ed</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gda-repetitive-statement-append-set.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="libgda-5.0-GdaRepetitiveStatement.html#GdaRepetitiveStatement" title="GdaRepetitiveStatement"><span class="type">GdaRepetitiveStatement</span></a> object</p>
</div>
<p class="since">Since: 4.2</p>
</div>
</div>
<div class="refsect1">
<a name="libgda-5.0-GdaRepetitiveStatement.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GdaRepetitiveStatement"></a><h3>GdaRepetitiveStatement</h3>
<pre class="programlisting">typedef struct {
GObject parent_instance;
} GdaRepetitiveStatement;
</pre>
</div>
</div>
<div class="refsect1">
<a name="libgda-5.0-GdaRepetitiveStatement.see-also"></a><h2>See Also</h2>
<p><a class="link" href="GdaStatement.html" title="GdaStatement"><span class="type">GdaStatement</span></a>, <a class="link" href="GdaBatch.html" title="GdaBatch"><span class="type">GdaBatch</span></a> and <a class="link" href="GdaConnection.html" title="GdaConnection"><span class="type">GdaConnection</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
|