libgda-4.0-doc 4.2.8-2build1 / usr / share / gtk-doc / html / libgda-4.0 / GdaDataModelBdb.html

This file is indexed.

/usr/share/gtk-doc/html/libgda-4.0/GdaDataModelBdb.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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GdaDataModelBdb</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="data_models.html" title="Data handling">
<link rel="prev" href="GdaRow.html" title="GdaDataModelArray's rows">
<link rel="next" href="GdaDataModelDir.html" title="GdaDataModelDir">
<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="GdaRow.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="data_models.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="GdaDataModelDir.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GdaDataModelBdb.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#GdaDataModelBdb.description" class="shortcut">Description</a>
                   | 
                  <a href="#GdaDataModelBdb.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#GdaDataModelBdb.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
                   | 
                  <a href="#GdaDataModelBdb.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="GdaDataModelBdb"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GdaDataModelBdb.top_of_page"></a>GdaDataModelBdb</span></h2>
<p>GdaDataModelBdb — GdaDataModel to access Berkeley DB database contents</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GdaDataModelBdb.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct              <a class="link" href="GdaDataModelBdb.html#GdaDataModelBdb-struct" title="struct GdaDataModelBdb">GdaDataModelBdb</a>;
struct              <a class="link" href="GdaDataModelBdb.html#GdaDataModelBdbClass" title="struct GdaDataModelBdbClass">GdaDataModelBdbClass</a>;
                    <a class="link" href="GdaDataModelBdb.html#GdaDataModelBdbPrivate" title="GdaDataModelBdbPrivate">GdaDataModelBdbPrivate</a>;
<a class="link" href="GdaDataModel.html" title="GdaDataModel"><span class="returnvalue">GdaDataModel</span></a> *      <a class="link" href="GdaDataModelBdb.html#gda-data-model-bdb-new" title="gda_data_model_bdb_new ()">gda_data_model_bdb_new</a>              (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *db_name</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="GdaDataModelBdb.html#gda-data-model-bdb-get-errors" title="gda_data_model_bdb_get_errors ()">gda_data_model_bdb_get_errors</a>       (<em class="parameter"><code><a class="link" href="GdaDataModelBdb.html" title="GdaDataModelBdb"><span class="type">GdaDataModelBdb</span></a> *model</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="GdaDataModelBdb.html#gda-data-model-bdb-clean-errors" title="gda_data_model_bdb_clean_errors ()">gda_data_model_bdb_clean_errors</a>     (<em class="parameter"><code><a class="link" href="GdaDataModelBdb.html" title="GdaDataModelBdb"><span class="type">GdaDataModelBdb</span></a> *model</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GdaDataModelBdb.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>
   +----GdaDataModelBdb
</pre>
</div>
<div class="refsect1">
<a name="GdaDataModelBdb.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GdaDataModelBdb implements
 <a class="link" href="GdaDataModel.html" title="GdaDataModel">GdaDataModel</a>.</p>
</div>
<div class="refsect1">
<a name="GdaDataModelBdb.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="GdaDataModelBdb.html#GdaDataModelBdb--db-name" title='The "db-name" property'>db-name</a>"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only
  "<a class="link" href="GdaDataModelBdb.html#GdaDataModelBdb--filename" title='The "filename" property'>filename</a>"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only
</pre>
</div>
<div class="refsect1">
<a name="GdaDataModelBdb.description"></a><h2>Description</h2>
<p>
The <a class="link" href="GdaDataModelBdb.html" title="GdaDataModelBdb"><span class="type">GdaDataModelBdb</span></a> object allows to access the contents of a Berkeley DB database as a
<a class="link" href="GdaDataModel.html" title="GdaDataModel"><span class="type">GdaDataModel</span></a> object.
</p>
<p>
By default the resulting GdaDataModel contains only two columns (named "key" and "data") of type
GDA_TYPE_BINARY, but this object can be subclassed to convert the key or data part of a BDB record
into several columns (implement the <code class="function">create_key_columns()</code>, <code class="function">create_data_columns()</code>, <code class="function">get_key_part()</code>, and <code class="function">get_data_part()</code>
virtual methods).
</p>
</div>
<div class="refsect1">
<a name="GdaDataModelBdb.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GdaDataModelBdb-struct"></a><h3>struct GdaDataModelBdb</h3>
<pre class="programlisting">struct GdaDataModelBdb;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="GdaDataModelBdbClass"></a><h3>struct GdaDataModelBdbClass</h3>
<pre class="programlisting">struct GdaDataModelBdbClass {
	GObjectClass            parent_class;

	/* virtual methods */
	GSList                *(*create_key_columns)  (GdaDataModelBdb *model);
	GSList                *(*create_data_columns) (GdaDataModelBdb *model);
	GValue                *(*get_key_part)        (GdaDataModelBdb *model, 
						       gpointer data, gint length, gint part);
	GValue                *(*get_data_part)       (GdaDataModelBdb *model,
						       gpointer data, gint length, gint part);
	gboolean               (*update_key_part)     (GdaDataModelBdb *model,
						       gpointer data, gint length, gint part, 
						       const GValue *value, GError **error);
	gboolean               (*update_data_part)    (GdaDataModelBdb *model,
						       gpointer data, gint length, gint part, 
						       const GValue *value, GError **error);

	/* Padding for future expansion */
	void (*_gda_reserved1) (void);
	void (*_gda_reserved2) (void);
	void (*_gda_reserved3) (void);
	void (*_gda_reserved4) (void);
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="GdaDataModelBdbPrivate"></a><h3>GdaDataModelBdbPrivate</h3>
<pre class="programlisting">typedef struct _GdaDataModelBdbPrivate GdaDataModelBdbPrivate;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gda-data-model-bdb-new"></a><h3>gda_data_model_bdb_new ()</h3>
<pre class="programlisting"><a class="link" href="GdaDataModel.html" title="GdaDataModel"><span class="returnvalue">GdaDataModel</span></a> *      gda_data_model_bdb_new              (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *db_name</code></em>);</pre>
<p>
Creates a new <a class="link" href="GdaDataModel.html" title="GdaDataModel"><span class="type">GdaDataModel</span></a> object to access the contents of the Berkeley DB file <em class="parameter"><code>file</code></em>,
for the database <em class="parameter"><code>db_name</code></em> if not <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>filename</code></em> :</span></p></td>
<td>name of the file containing the database</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>db_name</code></em> :</span></p></td>
<td>the name of the database within <em class="parameter"><code>filename</code></em>, 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="GdaDataModel.html" title="GdaDataModel"><span class="type">GdaDataModel</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-data-model-bdb-get-errors"></a><h3>gda_data_model_bdb_get_errors ()</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_data_model_bdb_get_errors       (<em class="parameter"><code><a class="link" href="GdaDataModelBdb.html" title="GdaDataModelBdb"><span class="type">GdaDataModelBdb</span></a> *model</code></em>);</pre>
<p>
Get the list of errors which have occurred while using <em class="parameter"><code>model</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>model</code></em> :</span></p></td>
<td>a <a class="link" href="GdaDataModelBdb.html" title="GdaDataModelBdb"><span class="type">GdaDataModelBdb</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a read-only list of <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> pointers, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if no error has occurred. <span class="annotation">[<a href="http://foldoc.org/element-type"><span class="acronym">element-type</span></a> GObject.Error][<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-data-model-bdb-clean-errors"></a><h3>gda_data_model_bdb_clean_errors ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gda_data_model_bdb_clean_errors     (<em class="parameter"><code><a class="link" href="GdaDataModelBdb.html" title="GdaDataModelBdb"><span class="type">GdaDataModelBdb</span></a> *model</code></em>);</pre>
<p>
Reset the list of errors which have occurred while using <em class="parameter"><code>model</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>model</code></em> :</span></p></td>
<td>a <a class="link" href="GdaDataModelBdb.html" title="GdaDataModelBdb"><span class="type">GdaDataModelBdb</span></a> object</td>
</tr></tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="GdaDataModelBdb.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GdaDataModelBdb--db-name"></a><h3>The <code class="literal">"db-name"</code> property</h3>
<pre class="programlisting">  "db-name"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only</pre>
<p>Name of the database.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="GdaDataModelBdb--filename"></a><h3>The <code class="literal">"filename"</code> property</h3>
<pre class="programlisting">  "filename"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only</pre>
<p>DB file.</p>
<p>Default value: NULL</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.17</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.