wxSQLite3 3.0.0
|
Interface for a user defined hook function. More...
#include <wxsqlite3.h>
Public Types | |
enum | wxUpdateType { SQLITE_DELETE = 9, SQLITE_INSERT = 18, SQLITE_UPDATE = 23 } |
Codes identifying the command for which the hook is called. More... | |
Public Member Functions | |
wxSQLite3Hook () | |
Default constructor. | |
virtual | ~wxSQLite3Hook () |
Virtual destructor. | |
virtual bool | CommitCallback () |
Execute the commit hook callback function. | |
virtual void | RollbackCallback () |
Execute the rollback hook callback function. | |
virtual void | UpdateCallback (wxUpdateType WXUNUSED(type), const wxString &WXUNUSED(database), const wxString &WXUNUSED(table), wxLongLong WXUNUSED(rowid)) |
Execute the hook callback function. | |
virtual int | WriteAheadLogCallback (const wxString &WXUNUSED(database), int WXUNUSED(numPages)) |
Execute the write-ahead log hook callback function. | |
void | SetDatabase (wxSQLite3Database *db) |
Set the associated database. | |
wxSQLite3Database * | GetDatabase () const |
Get the associated database. |
Interface for a user defined hook function.
wxSQLite3Hook::wxSQLite3Hook | ( | ) | [inline] |
Default constructor.
virtual wxSQLite3Hook::~wxSQLite3Hook | ( | ) | [inline, virtual] |
Virtual destructor.
virtual bool wxSQLite3Hook::CommitCallback | ( | ) | [inline, virtual] |
Execute the commit hook callback function.
Please refer to the SQLite documentation for further information.
wxSQLite3Database* wxSQLite3Hook::GetDatabase | ( | ) | const [inline] |
Get the associated database.
For the write-ahead log hook the associated database can be accessed.
virtual void wxSQLite3Hook::RollbackCallback | ( | ) | [inline, virtual] |
Execute the rollback hook callback function.
Please refer to the SQLite documentation for further information.
void wxSQLite3Hook::SetDatabase | ( | wxSQLite3Database * | db | ) | [inline] |
Set the associated database.
For the write-ahead log hook the associated database is set internally.
db | pointer to the associated database instance |
virtual void wxSQLite3Hook::UpdateCallback | ( | wxUpdateType | WXUNUSEDtype, |
const wxString & | WXUNUSEDdatabase, | ||
const wxString & | WXUNUSEDtable, | ||
wxLongLong | WXUNUSEDrowid | ||
) | [inline, virtual] |
Execute the hook callback function.
Please refer to the SQLite documentation for further information about the meaning of the parameters.
type | wxHookType. The value signifies what kind of operation is to be authorized. |
database | Name of the database |
table | Name of the table |
rowid | The rowid of the affected row |
virtual int wxSQLite3Hook::WriteAheadLogCallback | ( | const wxString & | WXUNUSEDdatabase, |
int | WXUNUSEDnumPages | ||
) | [inline, virtual] |
Execute the write-ahead log hook callback function.
Please refer to the SQLite documentation for further information about the meaning of the parameters.
database | Name of the database |
numPages | the number of pages |