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
|
<!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: wxSQLite3Hook 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-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">wxSQLite3Hook Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="wxSQLite3Hook" -->
<p>Interface for a user defined hook function.
<a href="classwx_s_q_lite3_hook.html#details">More...</a></p>
<p><code>#include <wxsqlite3.h></code></p>
<p><a href="classwx_s_q_lite3_hook-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_s_q_lite3_hook.html#aaf1da5402c7ceb813ed216d237edc5cd">wxUpdateType</a> { <a class="el" href="classwx_s_q_lite3_hook.html#aaf1da5402c7ceb813ed216d237edc5cda56f263980a9e19009fcb7393f2fc0a5f">SQLITE_DELETE</a> = 9,
<a class="el" href="classwx_s_q_lite3_hook.html#aaf1da5402c7ceb813ed216d237edc5cdacfbcb685be81f2e787012c2f8218cec1">SQLITE_INSERT</a> = 18,
<a class="el" href="classwx_s_q_lite3_hook.html#aaf1da5402c7ceb813ed216d237edc5cda4f7a431bf5027937aa0342558ad088a1">SQLITE_UPDATE</a> = 23
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Codes identifying the command for which the hook is called. <a href="classwx_s_q_lite3_hook.html#aaf1da5402c7ceb813ed216d237edc5cd">More...</a><br/></td></tr>
<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_hook.html#ac97e124c59dc13732fec0a46d1f96d76">wxSQLite3Hook</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#ac97e124c59dc13732fec0a46d1f96d76"></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_hook.html#a12eecc40480d405299194d2f29eb68ee">~wxSQLite3Hook</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Virtual destructor. <a href="#a12eecc40480d405299194d2f29eb68ee"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_s_q_lite3_hook.html#afa68c50e39650c763c86f38fdc64effd">CommitCallback</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Execute the commit hook callback function. <a href="#afa68c50e39650c763c86f38fdc64effd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_s_q_lite3_hook.html#a791fb16767a1aed55632436259cff730">RollbackCallback</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Execute the rollback hook callback function. <a href="#a791fb16767a1aed55632436259cff730"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_s_q_lite3_hook.html#a848bb62a5abc0cccc0212a4be5b9df15">UpdateCallback</a> (<a class="el" href="classwx_s_q_lite3_hook.html#aaf1da5402c7ceb813ed216d237edc5cd">wxUpdateType</a> WXUNUSED(type), const wxString &WXUNUSED(database), const wxString &WXUNUSED(table), wxLongLong WXUNUSED(rowid))</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Execute the hook callback function. <a href="#a848bb62a5abc0cccc0212a4be5b9df15"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_s_q_lite3_hook.html#a046f7bce85a84f24660ccb76359cce06">WriteAheadLogCallback</a> (const wxString &WXUNUSED(database), int WXUNUSED(numPages))</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Execute the write-ahead log hook callback function. <a href="#a046f7bce85a84f24660ccb76359cce06"></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_hook.html#a873e6b754c7803e8189fc1db7e94509a">SetDatabase</a> (<a class="el" href="classwx_s_q_lite3_database.html">wxSQLite3Database</a> *db)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the associated database. <a href="#a873e6b754c7803e8189fc1db7e94509a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classwx_s_q_lite3_database.html">wxSQLite3Database</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_s_q_lite3_hook.html#ae4137a1acb542a21318c8fdb1e2fb27a">GetDatabase</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the associated database. <a href="#ae4137a1acb542a21318c8fdb1e2fb27a"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Interface for a user defined hook function. </p>
</div><hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="aaf1da5402c7ceb813ed216d237edc5cd"></a><!-- doxytag: member="wxSQLite3Hook::wxUpdateType" ref="aaf1da5402c7ceb813ed216d237edc5cd" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classwx_s_q_lite3_hook.html#aaf1da5402c7ceb813ed216d237edc5cd">wxSQLite3Hook::wxUpdateType</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Codes identifying the command for which the hook is called. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="aaf1da5402c7ceb813ed216d237edc5cda56f263980a9e19009fcb7393f2fc0a5f"></a><!-- doxytag: member="SQLITE_DELETE" ref="aaf1da5402c7ceb813ed216d237edc5cda56f263980a9e19009fcb7393f2fc0a5f" args="" -->SQLITE_DELETE</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="aaf1da5402c7ceb813ed216d237edc5cdacfbcb685be81f2e787012c2f8218cec1"></a><!-- doxytag: member="SQLITE_INSERT" ref="aaf1da5402c7ceb813ed216d237edc5cdacfbcb685be81f2e787012c2f8218cec1" args="" -->SQLITE_INSERT</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="aaf1da5402c7ceb813ed216d237edc5cda4f7a431bf5027937aa0342558ad088a1"></a><!-- doxytag: member="SQLITE_UPDATE" ref="aaf1da5402c7ceb813ed216d237edc5cda4f7a431bf5027937aa0342558ad088a1" args="" -->SQLITE_UPDATE</em> </td><td>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ac97e124c59dc13732fec0a46d1f96d76"></a><!-- doxytag: member="wxSQLite3Hook::wxSQLite3Hook" ref="ac97e124c59dc13732fec0a46d1f96d76" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">wxSQLite3Hook::wxSQLite3Hook </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default constructor. </p>
</div>
</div>
<a class="anchor" id="a12eecc40480d405299194d2f29eb68ee"></a><!-- doxytag: member="wxSQLite3Hook::~wxSQLite3Hook" ref="a12eecc40480d405299194d2f29eb68ee" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual wxSQLite3Hook::~wxSQLite3Hook </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Virtual destructor. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="afa68c50e39650c763c86f38fdc64effd"></a><!-- doxytag: member="wxSQLite3Hook::CommitCallback" ref="afa68c50e39650c763c86f38fdc64effd" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool wxSQLite3Hook::CommitCallback </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Execute the commit hook callback function. </p>
<p>Please refer to the SQLite documentation for further information. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true to request rollback of the transaction, false to continue with commit </dd></dl>
</div>
</div>
<a class="anchor" id="ae4137a1acb542a21318c8fdb1e2fb27a"></a><!-- doxytag: member="wxSQLite3Hook::GetDatabase" ref="ae4137a1acb542a21318c8fdb1e2fb27a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classwx_s_q_lite3_database.html">wxSQLite3Database</a>* wxSQLite3Hook::GetDatabase </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the associated database. </p>
<p>For the write-ahead log hook the associated database can be accessed.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>pointer to the associated database instance </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>Access to the associated database is only provided for write-ahead log hooks. </dd></dl>
</div>
</div>
<a class="anchor" id="a791fb16767a1aed55632436259cff730"></a><!-- doxytag: member="wxSQLite3Hook::RollbackCallback" ref="a791fb16767a1aed55632436259cff730" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void wxSQLite3Hook::RollbackCallback </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Execute the rollback hook callback function. </p>
<p>Please refer to the SQLite documentation for further information. </p>
</div>
</div>
<a class="anchor" id="a873e6b754c7803e8189fc1db7e94509a"></a><!-- doxytag: member="wxSQLite3Hook::SetDatabase" ref="a873e6b754c7803e8189fc1db7e94509a" args="(wxSQLite3Database *db)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void wxSQLite3Hook::SetDatabase </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classwx_s_q_lite3_database.html">wxSQLite3Database</a> * </td>
<td class="paramname"><em>db</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the associated database. </p>
<p>For the write-ahead log hook the associated database is set internally. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">db</td><td>pointer to the associated database instance </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a848bb62a5abc0cccc0212a4be5b9df15"></a><!-- doxytag: member="wxSQLite3Hook::UpdateCallback" ref="a848bb62a5abc0cccc0212a4be5b9df15" args="(wxUpdateType WXUNUSED(type), const wxString &WXUNUSED(database), const wxString &WXUNUSED(table), wxLongLong WXUNUSED(rowid))" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void wxSQLite3Hook::UpdateCallback </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classwx_s_q_lite3_hook.html#aaf1da5402c7ceb813ed216d237edc5cd">wxUpdateType</a>  </td>
<td class="paramname"><em>WXUNUSED</em>type, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const wxString & </td>
<td class="paramname"><em>WXUNUSED</em>database, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const wxString & </td>
<td class="paramname"><em>WXUNUSED</em>table, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">wxLongLong  </td>
<td class="paramname"><em>WXUNUSED</em>rowid </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Execute the hook callback function. </p>
<p>Please refer to the SQLite documentation for further information about the meaning of the parameters.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">type</td><td>wxHookType. The value signifies what kind of operation is to be authorized. </td></tr>
<tr><td class="paramname">database</td><td>Name of the database </td></tr>
<tr><td class="paramname">table</td><td>Name of the table </td></tr>
<tr><td class="paramname">rowid</td><td>The rowid of the affected row </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a046f7bce85a84f24660ccb76359cce06"></a><!-- doxytag: member="wxSQLite3Hook::WriteAheadLogCallback" ref="a046f7bce85a84f24660ccb76359cce06" args="(const wxString &WXUNUSED(database), int WXUNUSED(numPages))" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int wxSQLite3Hook::WriteAheadLogCallback </td>
<td>(</td>
<td class="paramtype">const wxString & </td>
<td class="paramname"><em>WXUNUSED</em>database, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int  </td>
<td class="paramname"><em>WXUNUSED</em>numPages </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Execute the write-ahead log hook callback function. </p>
<p>Please refer to the SQLite documentation for further information about the meaning of the parameters.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">database</td><td>Name of the database </td></tr>
<tr><td class="paramname">numPages</td><td>the number of pages </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="wxsqlite3_8h.html">wxsqlite3.h</a></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Thu Jan 19 2012 16:17:48 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>
|
