libsqlite3x  2007.10.18
Classes | Typedefs | Functions
sqlite3x Namespace Reference

This namespace encapsulates a C++ API wrapper for sqlite3 databases. More...

Classes

class  sqlite3_connection
 Represents a connection to an sqlite3 database. More...
 
class  sqlite3_transaction
 Manages an sqlite3 transaction. More...
 
class  sqlite3_cursor
 A type for reading results from an sqlite3_command. More...
 
class  sqlite3_command
 Encapsulates a command to send to an sqlite3_connection. More...
 
class  database_error
 Exception type used by the sqlite3x classes. More...
 
class  table_generator
 EXPERIMENTAL. More...
 
class  settings_db
 settings_db ia a very simplistic settings-data database for use with the sqlite3x database layer. More...
 

Typedefs

typedef sqlite_int64 int64_t
 64-bit integer type used by this code.
 

Functions

bool rc_is_okay (int rc)
 rc_is_okay() is an easy way to check if rc is one of SQLITE_OK, SQLITE_ROW, or SQLITE_DONE. More...
 

Detailed Description

This namespace encapsulates a C++ API wrapper for sqlite3 databases.

It was originally written by Cory Nelson and was hacked slightly by stephan beal.

The home page for the original sources note that all of the w_char/wstring functions probably only work on Windows platforms. Your mileage may vary on other platforms. Users of this API are recommended to NOT use the wchar_t/wstring variants of any functions, as those functions may be removed at some point.

Note that this API does not include support for all sqlite3 features. However, the most commonly used features are available.

Function Documentation

bool sqlite3x::rc_is_okay ( int  rc)

rc_is_okay() is an easy way to check if rc is one of SQLITE_OK, SQLITE_ROW, or SQLITE_DONE.

This function returns true if rc is one of those values, else false. When writing code which accepts arbitrary client-supplied SQL, any of those three codes can signal success, depending on the SQL code and the context.

Definition at line 34 of file sqlite3x_connection.cpp.