1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2
<html xmlns="http://www.w3.org/1999/xhtml">
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5
<title>libgdamm: Gnome::Gda::BlobOp Class Reference</title>
7
<link href="tabs.css" rel="stylesheet" type="text/css"/>
8
<link href="doxygen.css" rel="stylesheet" type="text/css" />
14
<div id="top"><!-- do not remove this div! -->
18
<table cellspacing="0" cellpadding="0">
20
<tr style="height: 56px;">
23
<td style="padding-left: 0.5em;">
24
<div id="projectname">libgdamm
25
 <span id="projectnumber">4.99.6</span>
37
<!-- Generated by Doxygen 1.7.5.1-20110925 -->
38
<div id="navrow1" class="tabs">
40
<li><a href="index.html"><span>Main Page</span></a></li>
41
<li><a href="pages.html"><span>Related Pages</span></a></li>
42
<li><a href="modules.html"><span>Modules</span></a></li>
43
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
44
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
47
<div id="navrow2" class="tabs2">
49
<li><a href="annotated.html"><span>Class List</span></a></li>
50
<li><a href="classes.html"><span>Class Index</span></a></li>
51
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
52
<li><a href="functions.html"><span>Class Members</span></a></li>
55
<div id="nav-path" class="navpath">
57
<li class="navelem"><a class="el" href="namespaceGnome.html">Gnome</a> </li>
58
<li class="navelem"><a class="el" href="namespaceGnome_1_1Gda.html">Gda</a> </li>
59
<li class="navelem"><a class="el" href="classGnome_1_1Gda_1_1BlobOp.html">BlobOp</a> </li>
65
<a href="#pub-methods">Public Member Functions</a> |
66
<a href="#pub-static-methods">Static Public Member Functions</a> |
67
<a href="#pro-methods">Protected Member Functions</a> |
68
<a href="#related">Related Functions</a> </div>
69
<div class="headertitle">
70
<div class="title">Gnome::Gda::BlobOp Class Reference<div class="ingroups"><a class="el" href="group__DataHandlers.html">Data Handlers</a></div></div> </div>
72
<div class="contents">
73
<!-- doxytag: class="Gnome::Gda::BlobOp" --><!-- doxytag: inherits="Glib::Object" -->
74
<p>Blobs handling. <a href="classGnome_1_1Gda_1_1BlobOp.html#details">More...</a></p>
75
<div class="dynheader">
76
Inheritance diagram for Gnome::Gda::BlobOp:</div>
77
<div class="dyncontent">
78
<div class="center"><img src="classGnome_1_1Gda_1_1BlobOp__inherit__graph.png" border="0" usemap="#Gnome_1_1Gda_1_1BlobOp_inherit__map" alt="Inheritance graph"/></div>
79
<map name="Gnome_1_1Gda_1_1BlobOp_inherit__map" id="Gnome_1_1Gda_1_1BlobOp_inherit__map">
80
<area shape="rect" id="node2" /></map>
81
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
82
<div class="dynheader">
83
Collaboration diagram for Gnome::Gda::BlobOp:</div>
84
<div class="dyncontent">
85
<div class="center"><img src="classGnome_1_1Gda_1_1BlobOp__coll__graph.png" border="0" usemap="#Gnome_1_1Gda_1_1BlobOp_coll__map" alt="Collaboration graph"/></div>
86
<map name="Gnome_1_1Gda_1_1BlobOp_coll__map" id="Gnome_1_1Gda_1_1BlobOp_coll__map">
87
<area shape="rect" id="node2" /></map>
88
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
90
<p><a href="classGnome_1_1Gda_1_1BlobOp-members.html">List of all members.</a></p>
91
<table class="memberdecls">
92
<tr><td colspan="2"><h2><a name="pub-methods"></a>
93
Public Member Functions</h2></td></tr>
94
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1BlobOp.html#a473f158cf2d0ed47fdf6524e576035e2">~BlobOp</a> ()</td></tr>
95
<tr><td class="memItemLeft" align="right" valign="top">GdaBlobOp* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1BlobOp.html#ac487793d28664a80cc9d4cf7e117cc7c">gobj</a> ()</td></tr>
96
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#ac487793d28664a80cc9d4cf7e117cc7c"></a><br/></td></tr>
97
<tr><td class="memItemLeft" align="right" valign="top">const GdaBlobOp* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1BlobOp.html#aa31d5c63e437c4596c82d1843b005da1">gobj</a> () const </td></tr>
98
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#aa31d5c63e437c4596c82d1843b005da1"></a><br/></td></tr>
99
<tr><td class="memItemLeft" align="right" valign="top">GdaBlobOp* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1BlobOp.html#a76500b21d0930d41264b8402ecaa2087">gobj_copy</a> ()</td></tr>
100
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. <a href="#a76500b21d0930d41264b8402ecaa2087"></a><br/></td></tr>
101
<tr><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1BlobOp.html#ac3456bc16d3b7945019b48529664b80c">get_length</a> () const </td></tr>
102
<tr><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1BlobOp.html#a0075b2014defe7434d7bae84c5166ce7">read</a> (<a class="el" href="classGnome_1_1Gda_1_1Blob.html">Blob</a>& blob, long offset, long <a class="elRef" >size</a>)</td></tr>
103
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reads a chunk of bytes from the BLOB accessible through <em>op</em> into <em>blob</em>. <a href="#a0075b2014defe7434d7bae84c5166ce7"></a><br/></td></tr>
104
<tr><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1BlobOp.html#ab398f8cd90d887d9d3c6394ec29aed04">write</a> (<a class="el" href="classGnome_1_1Gda_1_1Blob.html">Blob</a>& blob, long offset)</td></tr>
105
<tr><td class="mdescLeft"> </td><td class="mdescRight">Writes a chunk of bytes from a <em>blob</em> to the BLOB accessible through <em>op</em>, <em>blob</em> is unchanged after this call. <a href="#ab398f8cd90d887d9d3c6394ec29aed04"></a><br/></td></tr>
106
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1BlobOp.html#a629bd67de63ee14defbc134d835ecbf6">read_all</a> (<a class="el" href="classGnome_1_1Gda_1_1Blob.html">Blob</a>& blob)</td></tr>
107
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reads the whole contents of the blob manipulated by <em>op</em> into <em>blob</em>. <a href="#a629bd67de63ee14defbc134d835ecbf6"></a><br/></td></tr>
108
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1BlobOp.html#aa24b7a9eea5c6d18cdebdd8ca47ddf00">write_all</a> (<a class="el" href="classGnome_1_1Gda_1_1Blob.html">Blob</a>& blob)</td></tr>
109
<tr><td class="mdescLeft"> </td><td class="mdescRight">Writes the whole contents of <em>blob</em> into the blob manipulated by <em>op</em>. <a href="#aa24b7a9eea5c6d18cdebdd8ca47ddf00"></a><br/></td></tr>
110
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
111
Static Public Member Functions</h2></td></tr>
112
<tr><td class="memItemLeft" align="right" valign="top">static <a class="elRef" >create</a> ()</td></tr>
113
<tr><td colspan="2"><h2><a name="pro-methods"></a>
114
Protected Member Functions</h2></td></tr>
115
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1BlobOp.html#a9f67edc01953c2ca71cbd2054cb65e84">BlobOp</a> ()</td></tr>
116
<tr><td colspan="2"><h2><a name="related"></a>
117
Related Functions</h2></td></tr>
118
<tr><td class="ititle" colspan="2"><p>(Note that these are not member functions.) </p>
120
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" >wrap</a> (GdaBlobOp* object, bool take_copy=false)</td></tr>
121
<tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="elRef" ></a><br/></td></tr>
123
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
124
<div class="textblock"><p>Blobs handling. </p>
125
<p>This object is a base class for individual database providers which support BLOB types. It supports operations to read and write data in a BLOB. </p>
126
</div><hr/><h2>Constructor & Destructor Documentation</h2>
127
<a class="anchor" id="a473f158cf2d0ed47fdf6524e576035e2"></a><!-- doxytag: member="Gnome::Gda::BlobOp::~BlobOp" ref="a473f158cf2d0ed47fdf6524e576035e2" args="()" -->
128
<div class="memitem">
129
<div class="memproto">
130
<table class="memname">
132
<td class="memname">virtual Gnome::Gda::BlobOp::~BlobOp </td>
134
<td class="paramname"></td><td>)</td>
135
<td><code> [virtual]</code></td>
143
<a class="anchor" id="a9f67edc01953c2ca71cbd2054cb65e84"></a><!-- doxytag: member="Gnome::Gda::BlobOp::BlobOp" ref="a9f67edc01953c2ca71cbd2054cb65e84" args="()" -->
144
<div class="memitem">
145
<div class="memproto">
146
<table class="memname">
148
<td class="memname">Gnome::Gda::BlobOp::BlobOp </td>
150
<td class="paramname"></td><td>)</td>
151
<td><code> [protected]</code></td>
159
<hr/><h2>Member Function Documentation</h2>
160
<a class="anchor" id="a42da10e4e61a1f3d91d1549b5ba7754d"></a><!-- doxytag: member="Gnome::Gda::BlobOp::create" ref="a42da10e4e61a1f3d91d1549b5ba7754d" args="()" -->
161
<div class="memitem">
162
<div class="memproto">
163
<table class="memname">
165
<td class="memname">static <a class="elRef" >BlobOp</a>> Gnome::Gda::BlobOp::create </td>
167
<td class="paramname"></td><td>)</td>
168
<td><code> [static]</code></td>
176
<a class="anchor" id="ac3456bc16d3b7945019b48529664b80c"></a><!-- doxytag: member="Gnome::Gda::BlobOp::get_length" ref="ac3456bc16d3b7945019b48529664b80c" args="() const " -->
177
<div class="memitem">
178
<div class="memproto">
179
<table class="memname">
181
<td class="memname">long Gnome::Gda::BlobOp::get_length </td>
183
<td class="paramname"></td><td>)</td>
189
<dl class="return"><dt><b>Returns:</b></dt><dd>The length of the blob in bytes. In case of error, -1 is returned and the provider should have added an error (a <a class="el" href="classGnome_1_1Gda_1_1ConnectionEvent.html" title="Any event which has occurred on a Gda::Connection.">Gda::ConnectionEvent</a>) to the connection. </dd></dl>
193
<a class="anchor" id="ac487793d28664a80cc9d4cf7e117cc7c"></a><!-- doxytag: member="Gnome::Gda::BlobOp::gobj" ref="ac487793d28664a80cc9d4cf7e117cc7c" args="()" -->
194
<div class="memitem">
195
<div class="memproto">
196
<table class="memname">
198
<td class="memname">GdaBlobOp* Gnome::Gda::BlobOp::gobj </td>
200
<td class="paramname"></td><td>)</td>
201
<td><code> [inline]</code></td>
207
<p>Provides access to the underlying C GObject. </p>
209
<p>Reimplemented from <a class="elRef" >Glib::ObjectBase</a>.</p>
213
<a class="anchor" id="aa31d5c63e437c4596c82d1843b005da1"></a><!-- doxytag: member="Gnome::Gda::BlobOp::gobj" ref="aa31d5c63e437c4596c82d1843b005da1" args="() const " -->
214
<div class="memitem">
215
<div class="memproto">
216
<table class="memname">
218
<td class="memname">const GdaBlobOp* Gnome::Gda::BlobOp::gobj </td>
220
<td class="paramname"></td><td>)</td>
221
<td> const<code> [inline]</code></td>
227
<p>Provides access to the underlying C GObject. </p>
229
<p>Reimplemented from <a class="elRef" >Glib::ObjectBase</a>.</p>
233
<a class="anchor" id="a76500b21d0930d41264b8402ecaa2087"></a><!-- doxytag: member="Gnome::Gda::BlobOp::gobj_copy" ref="a76500b21d0930d41264b8402ecaa2087" args="()" -->
234
<div class="memitem">
235
<div class="memproto">
236
<table class="memname">
238
<td class="memname">GdaBlobOp* Gnome::Gda::BlobOp::gobj_copy </td>
240
<td class="paramname"></td><td>)</td>
247
<p>Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. </p>
251
<a class="anchor" id="a0075b2014defe7434d7bae84c5166ce7"></a><!-- doxytag: member="Gnome::Gda::BlobOp::read" ref="a0075b2014defe7434d7bae84c5166ce7" args="(Blob &blob, long offset, long size)" -->
252
<div class="memitem">
253
<div class="memproto">
254
<table class="memname">
256
<td class="memname">long Gnome::Gda::BlobOp::read </td>
258
<td class="paramtype"><a class="el" href="classGnome_1_1Gda_1_1Blob.html">Blob</a>& </td>
259
<td class="paramname"><em>blob</em>, </td>
262
<td class="paramkey"></td>
264
<td class="paramtype">long </td>
265
<td class="paramname"><em>offset</em>, </td>
268
<td class="paramkey"></td>
270
<td class="paramtype">long </td>
271
<td class="paramname"><em>size</em> </td>
282
<p>Reads a chunk of bytes from the BLOB accessible through <em>op</em> into <em>blob</em>. </p>
283
<dl><dt><b>Parameters:</b></dt><dd>
284
<table class="params">
285
<tr><td class="paramname">blob</td><td>A <a class="el" href="classGnome_1_1Gda_1_1Blob.html" title="This object is a base class for individual database providers which support BLOB types.">Gda::Blob</a> to read data to. </td></tr>
286
<tr><td class="paramname">offset</td><td>Offset to read from the start of the blob (starts at 0). </td></tr>
287
<tr><td class="paramname">size</td><td>Maximum number of bytes to read. </td></tr>
291
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of bytes actually read. In case of error, -1 is returned and the provider should have added an error to the connection. </dd></dl>
295
<a class="anchor" id="a629bd67de63ee14defbc134d835ecbf6"></a><!-- doxytag: member="Gnome::Gda::BlobOp::read_all" ref="a629bd67de63ee14defbc134d835ecbf6" args="(Blob &blob)" -->
296
<div class="memitem">
297
<div class="memproto">
298
<table class="memname">
300
<td class="memname">bool Gnome::Gda::BlobOp::read_all </td>
302
<td class="paramtype"><a class="el" href="classGnome_1_1Gda_1_1Blob.html">Blob</a>& </td>
303
<td class="paramname"><em>blob</em></td><td>)</td>
310
<p>Reads the whole contents of the blob manipulated by <em>op</em> into <em>blob</em>. </p>
311
<dl><dt><b>Parameters:</b></dt><dd>
312
<table class="params">
313
<tr><td class="paramname">blob</td><td>A <a class="el" href="classGnome_1_1Gda_1_1Blob.html" title="This object is a base class for individual database providers which support BLOB types.">Gda::Blob</a> to read data to. </td></tr>
317
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if <em>blob->data</em> contains the whole BLOB manipulated by <em>op</em>. </dd></dl>
321
<a class="anchor" id="ab398f8cd90d887d9d3c6394ec29aed04"></a><!-- doxytag: member="Gnome::Gda::BlobOp::write" ref="ab398f8cd90d887d9d3c6394ec29aed04" args="(Blob &blob, long offset)" -->
322
<div class="memitem">
323
<div class="memproto">
324
<table class="memname">
326
<td class="memname">long Gnome::Gda::BlobOp::write </td>
328
<td class="paramtype"><a class="el" href="classGnome_1_1Gda_1_1Blob.html">Blob</a>& </td>
329
<td class="paramname"><em>blob</em>, </td>
332
<td class="paramkey"></td>
334
<td class="paramtype">long </td>
335
<td class="paramname"><em>offset</em> </td>
346
<p>Writes a chunk of bytes from a <em>blob</em> to the BLOB accessible through <em>op</em>, <em>blob</em> is unchanged after this call. </p>
347
<p>If <em>blob</em> has an associated <a class="el" href="classGnome_1_1Gda_1_1BlobOp.html" title="Blobs handling.">Gda::BlobOp</a> (ie. if <em>blob->op</em> is not <code>0</code>) then the data to be written using <em>op</em> is the data fetched using <em>blob->op</em>. </p>
348
<dl><dt><b>Parameters:</b></dt><dd>
349
<table class="params">
350
<tr><td class="paramname">blob</td><td>A <a class="el" href="classGnome_1_1Gda_1_1Blob.html" title="This object is a base class for individual database providers which support BLOB types.">Gda::Blob</a> which contains the data to write. </td></tr>
351
<tr><td class="paramname">offset</td><td>Offset to write from the start of the blob (starts at 0). </td></tr>
355
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of bytes written. In case of error, -1 is returned and the provider should have added an error to the connection. </dd></dl>
359
<a class="anchor" id="aa24b7a9eea5c6d18cdebdd8ca47ddf00"></a><!-- doxytag: member="Gnome::Gda::BlobOp::write_all" ref="aa24b7a9eea5c6d18cdebdd8ca47ddf00" args="(Blob &blob)" -->
360
<div class="memitem">
361
<div class="memproto">
362
<table class="memname">
364
<td class="memname">bool Gnome::Gda::BlobOp::write_all </td>
366
<td class="paramtype"><a class="el" href="classGnome_1_1Gda_1_1Blob.html">Blob</a>& </td>
367
<td class="paramname"><em>blob</em></td><td>)</td>
374
<p>Writes the whole contents of <em>blob</em> into the blob manipulated by <em>op</em>. </p>
375
<p>If necessary the resulting blob is truncated from its previous length. </p>
376
<dl><dt><b>Parameters:</b></dt><dd>
377
<table class="params">
378
<tr><td class="paramname">blob</td><td>A <a class="el" href="classGnome_1_1Gda_1_1Blob.html" title="This object is a base class for individual database providers which support BLOB types.">Gda::Blob</a> which contains the data to write. </td></tr>
382
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> on success. </dd></dl>
386
<hr/><h2>Friends And Related Function Documentation</h2>
387
<a class="anchor" id="ae0d2305566efb6bf56f2d525104ffbb1"></a><!-- doxytag: member="Gnome::Gda::BlobOp::wrap" ref="ae0d2305566efb6bf56f2d525104ffbb1" args="(GdaBlobOp *object, bool take_copy=false)" -->
388
<div class="memitem">
389
<div class="memproto">
390
<table class="memname">
392
<td class="memname"><a class="elRef" >Gnome::Gda::BlobOp</a> > wrap </td>
394
<td class="paramtype">GdaBlobOp * </td>
395
<td class="paramname"><em>object</em>, </td>
398
<td class="paramkey"></td>
400
<td class="paramtype">bool </td>
401
<td class="paramname"><em>take_copy</em> = <code>false</code> </td>
406
<td></td><td><code> [related]</code></td>
412
<p>A <a class="elRef" >Glib::wrap()</a> method for this object. </p>
413
<dl><dt><b>Parameters:</b></dt><dd>
414
<table class="params">
415
<tr><td class="paramname">object</td><td>The C instance. </td></tr>
416
<tr><td class="paramname">take_copy</td><td>False if the result should take ownership of the C instance. True if it should take a new copy or ref. </td></tr>
420
<dl class="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
424
<hr/>The documentation for this class was generated from the following file:<ul>
425
<li>libgdamm/blobop.h</li>
430
<hr class="footer"/><address class="footer"><small>
431
Generated on Sun Nov 20 2011 22:38:13 for libgdamm by  <a href="http://www.doxygen.org/index.html">
432
<img class="footer" src="doxygen.png" alt="doxygen"/>
433
</a> 1.7.5.1-20110925