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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GdaTable</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="index.html" title="GNOME Data Access manual">
<link rel="up" href="libgda-api.html" title="Client API Reference">
<link rel="prev" href="libgda-GdaSelect.html" title="GdaSelect">
<link rel="next" href="libgda-GdaTransaction.html" title="GdaTransaction">
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="introduction.html" title="Introduction">
<link rel="chapter" href="architecture.html" title="libgda architecture">
<link rel="chapter" href="installation.html" title="Installation">
<link rel="chapter" href="connecting.html" title="Beginning">
<link rel="chapter" href="processing-queries.html" title="Processing queries">
<link rel="chapter" href="ch06.html" title="Transactions and batch processes">
<link rel="chapter" href="managing-errors.html" title="Managing errors">
<link rel="chapter" href="main_example.html" title="Full example">
<link rel="chapter" href="migration.html" title="Some formulae for migration from old version">
<link rel="chapter" href="libgda-api.html" title="Client API Reference">
<link rel="chapter" href="libgda-providers.html" title="GDA Providers">
<link rel="chapter" href="libgda-xql.html" title="XML Queries">
<link rel="chapter" href="libgda-reports.html" title="GDA Report Engine">
<link rel="appendix" href="fdl.html" title="Appendix A. GNU Free Documentation License">
</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-GdaSelect.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgda-api.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 manual</th>
<td><a accesskey="n" href="libgda-GdaTransaction.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#libgda-GdaTable.synopsis" class="shortcut">Top</a>
|
<a href="#libgda-GdaTable.description" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libgda-GdaTable"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgda-GdaTable.top_of_page"></a>GdaTable</span></h2>
<p>GdaTable — An in-memory representation of a database table</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libgda-GdaTable.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
<a class="link" href="libgda-GdaTable.html#GdaTablePrivate" title="GdaTablePrivate">GdaTablePrivate</a>;
GdaTable* <a class="link" href="libgda-GdaTable.html#gda-table-new" title="gda_table_new ()">gda_table_new</a> (const gchar *name);
GdaTable* <a class="link" href="libgda-GdaTable.html#gda-table-new-from-model" title="gda_table_new_from_model ()">gda_table_new_from_model</a> (const gchar *name,
const <a class="link" href="libgda-gda-row.html#GdaDataModel" title="GdaDataModel">GdaDataModel</a> *model,
gboolean add_data);
const gchar* <a class="link" href="libgda-GdaTable.html#gda-table-get-name" title="gda_table_get_name ()">gda_table_get_name</a> (GdaTable *table);
void <a class="link" href="libgda-GdaTable.html#gda-table-set-name" title="gda_table_set_name ()">gda_table_set_name</a> (GdaTable *table,
const gchar *name);
void <a class="link" href="libgda-GdaTable.html#gda-table-add-field" title="gda_table_add_field ()">gda_table_add_field</a> (GdaTable *table,
const <a class="link" href="libgda-gda-field.html#GdaFieldAttributes" title="GdaFieldAttributes">GdaFieldAttributes</a> *fa);
void <a class="link" href="libgda-GdaTable.html#gda-table-add-data-from-model" title="gda_table_add_data_from_model ()">gda_table_add_data_from_model</a> (GdaTable *table,
const <a class="link" href="libgda-gda-row.html#GdaDataModel" title="GdaDataModel">GdaDataModel</a> *model);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="libgda-GdaTable.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="libgda-GdaTable.details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="GdaTablePrivate"></a><h3>GdaTablePrivate</h3>
<pre class="programlisting">typedef struct _GdaTablePrivate GdaTablePrivate;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gda-table-new"></a><h3>gda_table_new ()</h3>
<pre class="programlisting">GdaTable* gda_table_new (const gchar *name);</pre>
<p>
Creates a new <span class="type">GdaTable</span> object, which is an in-memory representation
of an entire table. It is mainly used by the <span class="type">GdaXmlDatabase</span> class,
but you can also use it in your applications for whatever you may need
it.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td> name for the new table.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the newly created object.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gda-table-new-from-model"></a><h3>gda_table_new_from_model ()</h3>
<pre class="programlisting">GdaTable* gda_table_new_from_model (const gchar *name,
const <a class="link" href="libgda-gda-row.html#GdaDataModel" title="GdaDataModel">GdaDataModel</a> *model,
gboolean add_data);</pre>
<p>
Creates a <span class="type">GdaTable</span> object from the given <a class="link" href="libgda-gda-row.html#GdaDataModel" title="GdaDataModel"><span class="type">GdaDataModel</span></a>. This
is very useful to maintain an in-memory copy of a given
recordset obtained from a database. This is also used when
exporting data to a <span class="type">GdaXmlDatabase</span> object.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td> name for the new table.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>model</code></em> :</span></p></td>
<td> model to create the table from.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>add_data</code></em> :</span></p></td>
<td> whether to add model's data or not.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the newly created object.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gda-table-get-name"></a><h3>gda_table_get_name ()</h3>
<pre class="programlisting">const gchar* gda_table_get_name (GdaTable *table);</pre>
<p>
</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>table</code></em> :</span></p></td>
<td> a <span class="type">GdaTable</span> object.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the name of the given <span class="type">GdaTable</span>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gda-table-set-name"></a><h3>gda_table_set_name ()</h3>
<pre class="programlisting">void gda_table_set_name (GdaTable *table,
const gchar *name);</pre>
<p>
Sets the name of the given <span class="type">GdaTable</span>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>table</code></em> :</span></p></td>
<td> a <span class="type">GdaTable</span> object.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td> new name for the table.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gda-table-add-field"></a><h3>gda_table_add_field ()</h3>
<pre class="programlisting">void gda_table_add_field (GdaTable *table,
const <a class="link" href="libgda-gda-field.html#GdaFieldAttributes" title="GdaFieldAttributes">GdaFieldAttributes</a> *fa);</pre>
<p>
Adds a field to the given <span class="type">GdaTable</span>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>table</code></em> :</span></p></td>
<td> a <span class="type">GdaTable</span> object.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>fa</code></em> :</span></p></td>
<td> attributes for the new field.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gda-table-add-data-from-model"></a><h3>gda_table_add_data_from_model ()</h3>
<pre class="programlisting">void gda_table_add_data_from_model (GdaTable *table,
const <a class="link" href="libgda-gda-row.html#GdaDataModel" title="GdaDataModel">GdaDataModel</a> *model);</pre>
<p>
Adds data in the given <em class="parameter"><code>table</code></em> from the given <em class="parameter"><code>model</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>table</code></em> :</span></p></td>
<td> a <span class="type">GdaTable</span> object.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>model</code></em> :</span></p></td>
<td> a <a class="link" href="libgda-gda-row.html#GdaDataModel" title="GdaDataModel"><span class="type">GdaDataModel</span></a> object.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.10</div>
</body>
</html>
|