Sq3LiteC_CC_API

Sq3LiteC - the class known as sq3lite or Lite defined by Sq3LiteS … More...

Collaboration diagram for Sq3LiteC_CC_API:

Topics
	Sq3LiteC_Class_CC_API
	Sq3LiteC - define the class …
	Sq3LiteC_TOR_CC_API
	Sq3LiteC - various functions to create, initialize and destroy …
	Sq3LiteC_Error_CC_API
	Sq3LiteC - work with an error …
	Sq3LiteC_Query_CC_API
	Sq3LiteC - work with a query …
	Sq3LiteC_Config_CC_API
	Sq3LiteC - configure the class …
	Sq3LiteC_Row_CC_API
	Sq3LiteC - work with a row …
	Sq3LiteC_Modify_CC_API
	Sq3LiteC - modify the database …
	Sq3LiteC_Info_CC_API
	Sq3LiteC - get information …
	Sq3LiteC_Execution_CC_API
	Sq3LiteC - execute a sql statement …
	Sq3LiteC_Misc_CC_API
	Sq3LiteC - various functions to perform misc operations …

Classes
struct	ccsq3lite::Sq3LiteC_A
	Struct to represent the data of the Sq3LiteC … → C-API: libsq3lite::Sq3LiteS More...
class	ccsq3lite::Sq3LiteC
	Struct to represent the data of the Sq3LiteC … → C-API: libsq3lite::Sq3LiteS More...

Functions
	ccsq3lite::Sq3LiteC::Sq3LiteC (SQ3_LITE hdl)
static Sq3LiteC *	ccsq3lite::Sq3LiteC::Sq3LiteC_ObjNew (MK_RT_ARGS SQ3_LITE hdl)
	return Sq3LiteC from LibMsgqueObject
SQ3_LITE	ccsq3lite::Sq3LiteC::getLITE () const
	return the LibMsgqueObject from current Sq3LiteC instance
SQ3_LITE	ccsq3lite::Sq3LiteC::getLITE__null_allow () const
	return the LibMsgqueObject from current Sq3LiteC instance
SQ3_LITEN	ccsq3lite::Sq3LiteC::getLITEN () const
	(const) return the LibMsgqueObject from current Sq3LiteC instance
SQ3_LITEN	ccsq3lite::Sq3LiteC::getLITEN__null_allow () const
	(const) return the LibMsgqueObject from current Sq3LiteC instance
static SQ3_LITE	ccsq3lite::Sq3LiteC::getLITE (Sq3LiteC *clsHdl)
	return LibMsgqueObject from current Sq3LiteC pointer
static SQ3_LITE	ccsq3lite::Sq3LiteC::getLITE__null_allow (Sq3LiteC *clsHdl)
	return LibMsgqueObject from current Sq3LiteC pointer
static SQ3_LITEN	ccsq3lite::Sq3LiteC::getLITEN (const Sq3LiteC *clsHdl)
	(const) return LibMsgqueObject from current Sq3LiteC pointer
static SQ3_LITEN	ccsq3lite::Sq3LiteC::getLITEN__null_allow (const Sq3LiteC *clsHdl)
	(const) return LibMsgqueObject from current Sq3LiteC pointer
static SQ3_LITE	ccsq3lite::Sq3LiteC::getLITE (const Sq3LiteC &clsHdl)
	return LibMsgqueObject from current Sq3LiteC reference
static SQ3_LITE	ccsq3lite::Sq3LiteC::getLITE__null_allow (const Sq3LiteC &clsHdl)
	return LibMsgqueObject from current Sq3LiteC reference
static SQ3_LITEN	ccsq3lite::Sq3LiteC::getLITEN (const Sq3LiteC &clsHdl)
	(const) return LibMsgqueObject from current Sq3LiteC reference
static SQ3_LITEN	ccsq3lite::Sq3LiteC::getLITEN__null_allow (const Sq3LiteC &clsHdl)
	(const) return LibMsgqueObject from current Sq3LiteC reference
bool	ccsq3lite::Sq3LiteC::Check () const
	check if pointer is still valid

Variables
static thread_local Sq3LiteC	ccsq3lite::Sq3LiteC::MK_NULL_REF = {(MK_OBJ)0}

Detailed Description

Sq3LiteC - the class known as sq3lite or Lite defined by Sq3LiteS …

Struct to represent the data of the Sq3LiteC …

Database Connection Handle …

Each open SQLite database is represented by a pointer to an instance of the opaque structure named "sqlite3". It is useful to think of an Sq3LiteC pointer as an object. The sqlite3_open (), sqlite3_open16 (), and Sq3LiteOpenV2 () interfaces are its constructors, and sqlite3_close () and Sq3LiteCloseV2 () are its destructors. There are many other interfaces (such as Sq3StmtPrepareV2 (), sqlite3_create_function (), and Sq3LiteBusyTimeout () to name but three) that are methods on an Sq3LiteC object.

Reference code from sqlite3:

typedef struct sqlite3 sqlite3;

Function Documentation

Check()

bool ccsq3lite::Sq3LiteC::Check ( ) const

inline

check if pointer is still valid

Definition at line 192 of file Sq3LiteC_cc.hh.

                         {
        return (hdl && Sq3LiteCheck(hdl));
      };

getLITE() [1/3]

SQ3_LITE ccsq3lite::Sq3LiteC::getLITE ( ) const

inline

return the LibMsgqueObject from current Sq3LiteC instance

Definition at line 124 of file Sq3LiteC_cc.hh.

                               {
        SQ3_LITE ret = reinterpret_cast<SQ3_LITE>(hdl);
        if (unlikely(ret == NULL)) InstHdlIsNullError();
        return ret;
      };

getLITE() [2/3]

static SQ3_LITE ccsq3lite::Sq3LiteC::getLITE ( const Sq3LiteC & clsHdl )

inlinestatic

return LibMsgqueObject from current Sq3LiteC reference

Definition at line 172 of file Sq3LiteC_cc.hh.

                                                      {
        return clsHdl.getLITE();
      };

getLITE() [3/3]

static SQ3_LITE ccsq3lite::Sq3LiteC::getLITE ( Sq3LiteC * clsHdl )

inlinestatic

return LibMsgqueObject from current Sq3LiteC pointer

Definition at line 148 of file Sq3LiteC_cc.hh.

                                                {
        SQ3_LITE ret = clsHdl ? reinterpret_cast<SQ3_LITE>(clsHdl->hdl) : NULL;
        if (unlikely(ret == NULL)) ClassHdlIsNullError(Sq3LiteC);
        return ret;
      };

getLITE__null_allow() [1/3]

SQ3_LITE ccsq3lite::Sq3LiteC::getLITE__null_allow ( ) const

inline

return the LibMsgqueObject from current Sq3LiteC instance

Definition at line 131 of file Sq3LiteC_cc.hh.

                                           {
        return reinterpret_cast<SQ3_LITE>(hdl);
      };

Here is the caller graph for this function:

getLITE__null_allow() [2/3]

static SQ3_LITE ccsq3lite::Sq3LiteC::getLITE__null_allow ( const Sq3LiteC & clsHdl )

inlinestatic

return LibMsgqueObject from current Sq3LiteC reference

Definition at line 177 of file Sq3LiteC_cc.hh.

                                                                  {
        return clsHdl.getLITE__null_allow();
      };

getLITE__null_allow() [3/3]

static SQ3_LITE ccsq3lite::Sq3LiteC::getLITE__null_allow ( Sq3LiteC * clsHdl )

inlinestatic

return LibMsgqueObject from current Sq3LiteC pointer

Definition at line 155 of file Sq3LiteC_cc.hh.

                                                            {
        return clsHdl ? reinterpret_cast<SQ3_LITE>(clsHdl->hdl) : NULL;
      };

getLITEN() [1/3]

SQ3_LITEN ccsq3lite::Sq3LiteC::getLITEN ( ) const

inline

(const) return the LibMsgqueObject from current Sq3LiteC instance

Definition at line 136 of file Sq3LiteC_cc.hh.

                                 {
        SQ3_LITEN ret = reinterpret_cast<SQ3_LITEN>(hdl);
        if (unlikely(ret == NULL)) InstHdlIsNullError();
        return ret;
      };

Here is the caller graph for this function:

getLITEN() [2/3]

static SQ3_LITEN ccsq3lite::Sq3LiteC::getLITEN ( const Sq3LiteC & clsHdl )

inlinestatic

(const) return LibMsgqueObject from current Sq3LiteC reference

Definition at line 182 of file Sq3LiteC_cc.hh.

                                                        {
        return clsHdl.getLITEN();
      };

getLITEN() [3/3]

static SQ3_LITEN ccsq3lite::Sq3LiteC::getLITEN ( const Sq3LiteC * clsHdl )

inlinestatic

(const) return LibMsgqueObject from current Sq3LiteC pointer

Definition at line 160 of file Sq3LiteC_cc.hh.

                                                        {
        SQ3_LITEN ret = clsHdl ? reinterpret_cast<SQ3_LITEN>(clsHdl->hdl) : NULL;
        if (unlikely(ret == NULL)) ClassHdlIsNullError(Sq3LiteC);
        return ret;
      };

getLITEN__null_allow() [1/3]

SQ3_LITEN ccsq3lite::Sq3LiteC::getLITEN__null_allow ( ) const

inline

(const) return the LibMsgqueObject from current Sq3LiteC instance

Definition at line 143 of file Sq3LiteC_cc.hh.

                                             {
        return reinterpret_cast<SQ3_LITEN>(hdl);
      };

Here is the caller graph for this function:

getLITEN__null_allow() [2/3]

static SQ3_LITEN ccsq3lite::Sq3LiteC::getLITEN__null_allow ( const Sq3LiteC & clsHdl )

inlinestatic

(const) return LibMsgqueObject from current Sq3LiteC reference

Definition at line 187 of file Sq3LiteC_cc.hh.

                                                                    {
        return clsHdl.getLITEN__null_allow();
      };

getLITEN__null_allow() [3/3]

static SQ3_LITEN ccsq3lite::Sq3LiteC::getLITEN__null_allow ( const Sq3LiteC * clsHdl )

inlinestatic

(const) return LibMsgqueObject from current Sq3LiteC pointer

Definition at line 167 of file Sq3LiteC_cc.hh.

                                                                    {
        return clsHdl ? reinterpret_cast<SQ3_LITEN>(clsHdl->hdl) : NULL;
      };

Sq3LiteC()

ccsq3lite::Sq3LiteC::Sq3LiteC ( SQ3_LITE hdl )

inline

Definition at line 115 of file Sq3LiteC_cc.hh.

: MkObjectC(Sq3LiteC_X2obj(hdl)) {};

Sq3LiteC_ObjNew()

static Sq3LiteC * ccsq3lite::Sq3LiteC::Sq3LiteC_ObjNew ( MK_RT_ARGS SQ3_LITE hdl )

inlinestatic

return Sq3LiteC from LibMsgqueObject

Definition at line 119 of file Sq3LiteC_cc.hh.

                                                                 {
        return (hdl ? static_cast<Sq3LiteC*>(MkObjectC::atomObjNew(MK_RT_CALL Sq3LiteC_X2obj(hdl))) : &MK_NULL_REF);
      }

Here is the caller graph for this function:

Variable Documentation

MK_NULL_REF

thread_local Sq3LiteC ccsq3lite::Sq3LiteC::MK_NULL_REF = {(MK_OBJ)0}

static

Definition at line 76 of file Sq3LiteC_cc.hh.