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
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>wxSQLite3: wxSQLite3Blob Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">wxSQLite3 <span id="projectnumber">3.0.0</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">wxSQLite3Blob Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="wxSQLite3Blob" -->
<p>Represents a SQLite BLOB handle.
<a href="classwx_s_q_lite3_blob.html#details">More...</a></p>
<p><code>#include <wxsqlite3.h></code></p>
<p><a href="classwx_s_q_lite3_blob-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_s_q_lite3_blob.html#a4a28f3cc1e67e9d8fe7c0a7b48328965">wxSQLite3Blob</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a4a28f3cc1e67e9d8fe7c0a7b48328965"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_s_q_lite3_blob.html#a784bc3d0b8dfcf06f709a03274770499">wxSQLite3Blob</a> (const <a class="el" href="classwx_s_q_lite3_blob.html">wxSQLite3Blob</a> &blob)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#a784bc3d0b8dfcf06f709a03274770499"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classwx_s_q_lite3_blob.html">wxSQLite3Blob</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_s_q_lite3_blob.html#a2d4f30c31f3775ff19e37bf294e3fbf2">operator=</a> (const <a class="el" href="classwx_s_q_lite3_blob.html">wxSQLite3Blob</a> &blob)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assignement constructor. <a href="#a2d4f30c31f3775ff19e37bf294e3fbf2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_s_q_lite3_blob.html#adfbc60ac8980f2dedb1c2c1364bcf510">wxSQLite3Blob</a> (<a class="el" href="classwx_s_q_lite3_database_reference.html">wxSQLite3DatabaseReference</a> *m_db, <a class="el" href="classwx_s_q_lite3_blob_reference.html">wxSQLite3BlobReference</a> *blobHandle, bool writable)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor (internal use only) <a href="#adfbc60ac8980f2dedb1c2c1364bcf510"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_s_q_lite3_blob.html#abc0c78942414810b645cc63705e52616">~wxSQLite3Blob</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#abc0c78942414810b645cc63705e52616"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">wxMemoryBuffer & </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_s_q_lite3_blob.html#a66f72f173c873ebeceb7d35de512b2d7">Read</a> (wxMemoryBuffer &blobValue, int length, int offset)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read partial BLOB value. <a href="#a66f72f173c873ebeceb7d35de512b2d7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_s_q_lite3_blob.html#aeb31552adcaa48a271d4858719f123f7">Write</a> (const wxMemoryBuffer &blobValue, int offset)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Write partial BLOB value. <a href="#aeb31552adcaa48a271d4858719f123f7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_s_q_lite3_blob.html#a659c8eeceddaf69d92f2119ad2d2a398">IsOk</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check whether the BLOB handle is correctly initialized. <a href="#a659c8eeceddaf69d92f2119ad2d2a398"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_s_q_lite3_blob.html#a6df79a7db994dac9cce9a5c0b5bb8f6d">IsReadOnly</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check whether the BLOB handle is read only. <a href="#a6df79a7db994dac9cce9a5c0b5bb8f6d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_s_q_lite3_blob.html#aa744d424869f3d03a33993cf5dc2d8de">GetSize</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the size of the associated BLOB. <a href="#aa744d424869f3d03a33993cf5dc2d8de"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_s_q_lite3_blob.html#a70ea4f4124b615258f5515686ed70d1d">Rebind</a> (wxLongLong rowid)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Rebind the associated BLOB to a new row. <a href="#a70ea4f4124b615258f5515686ed70d1d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_s_q_lite3_blob.html#ae34c9db7ea957de0f6cc52bcd1b7e132">Finalize</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Finalize the BLOB. <a href="#ae34c9db7ea957de0f6cc52bcd1b7e132"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Represents a SQLite BLOB handle. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a4a28f3cc1e67e9d8fe7c0a7b48328965"></a><!-- doxytag: member="wxSQLite3Blob::wxSQLite3Blob" ref="a4a28f3cc1e67e9d8fe7c0a7b48328965" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">wxSQLite3Blob::wxSQLite3Blob </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
</div>
</div>
<a class="anchor" id="a784bc3d0b8dfcf06f709a03274770499"></a><!-- doxytag: member="wxSQLite3Blob::wxSQLite3Blob" ref="a784bc3d0b8dfcf06f709a03274770499" args="(const wxSQLite3Blob &blob)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">wxSQLite3Blob::wxSQLite3Blob </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classwx_s_q_lite3_blob.html">wxSQLite3Blob</a> & </td>
<td class="paramname"><em>blob</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Copy constructor. </p>
</div>
</div>
<a class="anchor" id="adfbc60ac8980f2dedb1c2c1364bcf510"></a><!-- doxytag: member="wxSQLite3Blob::wxSQLite3Blob" ref="adfbc60ac8980f2dedb1c2c1364bcf510" args="(wxSQLite3DatabaseReference *m_db, wxSQLite3BlobReference *blobHandle, bool writable)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">wxSQLite3Blob::wxSQLite3Blob </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classwx_s_q_lite3_database_reference.html">wxSQLite3DatabaseReference</a> * </td>
<td class="paramname"><em>m_db</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classwx_s_q_lite3_blob_reference.html">wxSQLite3BlobReference</a> * </td>
<td class="paramname"><em>blobHandle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>writable</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor (internal use only) </p>
</div>
</div>
<a class="anchor" id="abc0c78942414810b645cc63705e52616"></a><!-- doxytag: member="wxSQLite3Blob::~wxSQLite3Blob" ref="abc0c78942414810b645cc63705e52616" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">wxSQLite3Blob::~wxSQLite3Blob </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ae34c9db7ea957de0f6cc52bcd1b7e132"></a><!-- doxytag: member="wxSQLite3Blob::Finalize" ref="ae34c9db7ea957de0f6cc52bcd1b7e132" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void wxSQLite3Blob::Finalize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Finalize the BLOB. </p>
</div>
</div>
<a class="anchor" id="aa744d424869f3d03a33993cf5dc2d8de"></a><!-- doxytag: member="wxSQLite3Blob::GetSize" ref="aa744d424869f3d03a33993cf5dc2d8de" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int wxSQLite3Blob::GetSize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the size of the associated BLOB. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the BLOB size </dd></dl>
</div>
</div>
<a class="anchor" id="a659c8eeceddaf69d92f2119ad2d2a398"></a><!-- doxytag: member="wxSQLite3Blob::IsOk" ref="a659c8eeceddaf69d92f2119ad2d2a398" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool wxSQLite3Blob::IsOk </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check whether the BLOB handle is correctly initialized. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>TRUE if the BLOB handle is correctly initialized, FALSE otherweis </dd></dl>
</div>
</div>
<a class="anchor" id="a6df79a7db994dac9cce9a5c0b5bb8f6d"></a><!-- doxytag: member="wxSQLite3Blob::IsReadOnly" ref="a6df79a7db994dac9cce9a5c0b5bb8f6d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool wxSQLite3Blob::IsReadOnly </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check whether the BLOB handle is read only. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>TRUE if the BLOB handle is readonly, FALSE otherweis </dd></dl>
</div>
</div>
<a class="anchor" id="a2d4f30c31f3775ff19e37bf294e3fbf2"></a><!-- doxytag: member="wxSQLite3Blob::operator=" ref="a2d4f30c31f3775ff19e37bf294e3fbf2" args="(const wxSQLite3Blob &blob)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classwx_s_q_lite3_blob.html">wxSQLite3Blob</a> & wxSQLite3Blob::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classwx_s_q_lite3_blob.html">wxSQLite3Blob</a> & </td>
<td class="paramname"><em>blob</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Assignement constructor. </p>
</div>
</div>
<a class="anchor" id="a66f72f173c873ebeceb7d35de512b2d7"></a><!-- doxytag: member="wxSQLite3Blob::Read" ref="a66f72f173c873ebeceb7d35de512b2d7" args="(wxMemoryBuffer &blobValue, int length, int offset)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">wxMemoryBuffer & wxSQLite3Blob::Read </td>
<td>(</td>
<td class="paramtype">wxMemoryBuffer & </td>
<td class="paramname"><em>blobValue</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>offset</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Read partial BLOB value. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">blobValue</td><td>memory buffer receiving the partial content of the BLOB </td></tr>
<tr><td class="paramname">length</td><td>length of BLOB content to be read </td></tr>
<tr><td class="paramname">offset</td><td>offset within BLOB where the read starts </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the address of the memory buffer </dd></dl>
</div>
</div>
<a class="anchor" id="a70ea4f4124b615258f5515686ed70d1d"></a><!-- doxytag: member="wxSQLite3Blob::Rebind" ref="a70ea4f4124b615258f5515686ed70d1d" args="(wxLongLong rowid)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void wxSQLite3Blob::Rebind </td>
<td>(</td>
<td class="paramtype">wxLongLong </td>
<td class="paramname"><em>rowid</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Rebind the associated BLOB to a new row. </p>
<p>Please refer to the SQLite documentation for further information (see function sqlite3_blob_reopen) </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">rowid</td><td>id of the row to which the BLOB should be rebound </td></tr>
</table>
</dd>
</dl>
<dl class="since"><dt><b>Since:</b></dt><dd>SQLite3 version 3.7.4 </dd></dl>
</div>
</div>
<a class="anchor" id="aeb31552adcaa48a271d4858719f123f7"></a><!-- doxytag: member="wxSQLite3Blob::Write" ref="aeb31552adcaa48a271d4858719f123f7" args="(const wxMemoryBuffer &blobValue, int offset)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void wxSQLite3Blob::Write </td>
<td>(</td>
<td class="paramtype">const wxMemoryBuffer & </td>
<td class="paramname"><em>blobValue</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>offset</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Write partial BLOB value. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">blobValue</td><td>memory buffer receiving the partial content of the BLOB </td></tr>
<tr><td class="paramname">offset</td><td>offset within BLOB where the read starts </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="wxsqlite3_8h.html">wxsqlite3.h</a></li>
<li><a class="el" href="wxsqlite3_8cpp.html">wxsqlite3.cpp</a></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Thu Jan 19 2012 16:17:47 for wxSQLite3 by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
|
