Sq3StmtC_CC_API

Sq3StmtC - the class known as sq3stmt or Statement defined by Sq3StmtS … More...

Collaboration diagram for Sq3StmtC_CC_API:

Topics
	Sq3StmtC_Class_CC_API
	Sq3StmtC - define the class …
	Sq3StmtC_TOR_CC_API
	Sq3StmtC - various functions to create, initialize and destroy …
	Sq3StmtC_Bind_CC_API
	Sq3StmtC - bind a type …
	Sq3StmtC_Column_CC_API
	Sq3StmtC - Result Values From A Query …
	Sq3StmtC_Info_CC_API
	Sq3StmtC - get type-information …
	Sq3StmtC_Sql_CC_API
	Sq3StmtC - Retrieving Statement SQL …
	Sq3StmtC_Misc_CC_API
	Sq3StmtC - various functions to perform misc operations …

Classes
struct	ccsq3lite::Sq3StmtC_A
	Struct to represent the data of the Sq3StmtC … → C-API: libsq3lite::Sq3StmtS More...
class	ccsq3lite::Sq3StmtC
	Struct to represent the data of the Sq3StmtC … → C-API: libsq3lite::Sq3StmtS More...

Functions
	ccsq3lite::Sq3StmtC::Sq3StmtC (SQ3_STMT hdl)
static Sq3StmtC *	ccsq3lite::Sq3StmtC::Sq3StmtC_ObjNew (MK_RT_ARGS SQ3_STMT hdl)
	return Sq3StmtC from LibMsgqueObject
SQ3_STMT	ccsq3lite::Sq3StmtC::getSTMT () const
	return the LibMsgqueObject from current Sq3StmtC instance
SQ3_STMT	ccsq3lite::Sq3StmtC::getSTMT__null_allow () const
	return the LibMsgqueObject from current Sq3StmtC instance
SQ3_STMTN	ccsq3lite::Sq3StmtC::getSTMTN () const
	(const) return the LibMsgqueObject from current Sq3StmtC instance
SQ3_STMTN	ccsq3lite::Sq3StmtC::getSTMTN__null_allow () const
	(const) return the LibMsgqueObject from current Sq3StmtC instance
static SQ3_STMT	ccsq3lite::Sq3StmtC::getSTMT (Sq3StmtC *clsHdl)
	return LibMsgqueObject from current Sq3StmtC pointer
static SQ3_STMT	ccsq3lite::Sq3StmtC::getSTMT__null_allow (Sq3StmtC *clsHdl)
	return LibMsgqueObject from current Sq3StmtC pointer
static SQ3_STMTN	ccsq3lite::Sq3StmtC::getSTMTN (const Sq3StmtC *clsHdl)
	(const) return LibMsgqueObject from current Sq3StmtC pointer
static SQ3_STMTN	ccsq3lite::Sq3StmtC::getSTMTN__null_allow (const Sq3StmtC *clsHdl)
	(const) return LibMsgqueObject from current Sq3StmtC pointer
static SQ3_STMT	ccsq3lite::Sq3StmtC::getSTMT (const Sq3StmtC &clsHdl)
	return LibMsgqueObject from current Sq3StmtC reference
static SQ3_STMT	ccsq3lite::Sq3StmtC::getSTMT__null_allow (const Sq3StmtC &clsHdl)
	return LibMsgqueObject from current Sq3StmtC reference
static SQ3_STMTN	ccsq3lite::Sq3StmtC::getSTMTN (const Sq3StmtC &clsHdl)
	(const) return LibMsgqueObject from current Sq3StmtC reference
static SQ3_STMTN	ccsq3lite::Sq3StmtC::getSTMTN__null_allow (const Sq3StmtC &clsHdl)
	(const) return LibMsgqueObject from current Sq3StmtC reference
bool	ccsq3lite::Sq3StmtC::Check () const
	check if pointer is still valid

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

Detailed Description

Sq3StmtC - the class known as sq3stmt or Statement defined by Sq3StmtS …

Struct to represent the data of the Sq3StmtC …

Prepared Statement Object …

An instance of this object represents a single SQL statement that has been compiled into binary form and is ready to be evaluated.

Think of each SQL statement as a separate computer program. The original SQL text is source code. A prepared statement object is the compiled object code. All SQL must be converted into a prepared statement before it can be run.

The life-cycle of a prepared statement object usually goes like this:

1. Create the prepared statement object using Sq3StmtPrepareV2 ().
2. Bind values to parameters using the Sq3StmtBindValue*() interfaces.
3. Run the SQL by calling Sq3StmtStep () one or more times.
4. Reset the prepared statement using Sq3StmtReset () then go back to step 2. Do this zero or more times.
5. Destroy the object using Sq3StmtFinalize ().

Reference code from sqlite3:

typedef struct sqlite3_stmt sqlite3_stmt;

Function Documentation

Check()

bool ccsq3lite::Sq3StmtC::Check ( ) const

inline

check if pointer is still valid

Definition at line 152 of file Sq3StmtC_cc.hh.

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

getSTMT() [1/3]

SQ3_STMT ccsq3lite::Sq3StmtC::getSTMT ( ) const

inline

return the LibMsgqueObject from current Sq3StmtC instance

Definition at line 84 of file Sq3StmtC_cc.hh.

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

Here is the caller graph for this function:

getSTMT() [2/3]

static SQ3_STMT ccsq3lite::Sq3StmtC::getSTMT ( const Sq3StmtC & clsHdl )

inlinestatic

return LibMsgqueObject from current Sq3StmtC reference

Definition at line 132 of file Sq3StmtC_cc.hh.

                                                      {
        return clsHdl.getSTMT();
      };

getSTMT() [3/3]

static SQ3_STMT ccsq3lite::Sq3StmtC::getSTMT ( Sq3StmtC * clsHdl )

inlinestatic

return LibMsgqueObject from current Sq3StmtC pointer

Definition at line 108 of file Sq3StmtC_cc.hh.

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

getSTMT__null_allow() [1/3]

SQ3_STMT ccsq3lite::Sq3StmtC::getSTMT__null_allow ( ) const

inline

return the LibMsgqueObject from current Sq3StmtC instance

Definition at line 91 of file Sq3StmtC_cc.hh.

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

Here is the caller graph for this function:

getSTMT__null_allow() [2/3]

static SQ3_STMT ccsq3lite::Sq3StmtC::getSTMT__null_allow ( const Sq3StmtC & clsHdl )

inlinestatic

return LibMsgqueObject from current Sq3StmtC reference

Definition at line 137 of file Sq3StmtC_cc.hh.

                                                                  {
        return clsHdl.getSTMT__null_allow();
      };

getSTMT__null_allow() [3/3]

static SQ3_STMT ccsq3lite::Sq3StmtC::getSTMT__null_allow ( Sq3StmtC * clsHdl )

inlinestatic

return LibMsgqueObject from current Sq3StmtC pointer

Definition at line 115 of file Sq3StmtC_cc.hh.

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

getSTMTN() [1/3]

SQ3_STMTN ccsq3lite::Sq3StmtC::getSTMTN ( ) const

inline

(const) return the LibMsgqueObject from current Sq3StmtC instance

Definition at line 96 of file Sq3StmtC_cc.hh.

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

Here is the caller graph for this function:

getSTMTN() [2/3]

static SQ3_STMTN ccsq3lite::Sq3StmtC::getSTMTN ( const Sq3StmtC & clsHdl )

inlinestatic

(const) return LibMsgqueObject from current Sq3StmtC reference

Definition at line 142 of file Sq3StmtC_cc.hh.

                                                        {
        return clsHdl.getSTMTN();
      };

getSTMTN() [3/3]

static SQ3_STMTN ccsq3lite::Sq3StmtC::getSTMTN ( const Sq3StmtC * clsHdl )

inlinestatic

(const) return LibMsgqueObject from current Sq3StmtC pointer

Definition at line 120 of file Sq3StmtC_cc.hh.

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

getSTMTN__null_allow() [1/3]

SQ3_STMTN ccsq3lite::Sq3StmtC::getSTMTN__null_allow ( ) const

inline

(const) return the LibMsgqueObject from current Sq3StmtC instance

Definition at line 103 of file Sq3StmtC_cc.hh.

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

Here is the caller graph for this function:

getSTMTN__null_allow() [2/3]

static SQ3_STMTN ccsq3lite::Sq3StmtC::getSTMTN__null_allow ( const Sq3StmtC & clsHdl )

inlinestatic

(const) return LibMsgqueObject from current Sq3StmtC reference

Definition at line 147 of file Sq3StmtC_cc.hh.

                                                                    {
        return clsHdl.getSTMTN__null_allow();
      };

getSTMTN__null_allow() [3/3]

static SQ3_STMTN ccsq3lite::Sq3StmtC::getSTMTN__null_allow ( const Sq3StmtC * clsHdl )

inlinestatic

(const) return LibMsgqueObject from current Sq3StmtC pointer

Definition at line 127 of file Sq3StmtC_cc.hh.

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

Sq3StmtC()

ccsq3lite::Sq3StmtC::Sq3StmtC ( SQ3_STMT hdl )

inline

Definition at line 75 of file Sq3StmtC_cc.hh.

: MkObjectC(Sq3StmtC_X2obj(hdl)) {};

Sq3StmtC_ObjNew()

static Sq3StmtC * ccsq3lite::Sq3StmtC::Sq3StmtC_ObjNew ( MK_RT_ARGS SQ3_STMT hdl )

inlinestatic

return Sq3StmtC from LibMsgqueObject

Definition at line 79 of file Sq3StmtC_cc.hh.

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

Here is the caller graph for this function:

Variable Documentation

MK_NULL_REF

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

static

Definition at line 36 of file Sq3StmtC_cc.hh.