CDBParams Class Reference
[Database Server Interfaces]

Search Toolkit Book for CDBParams

#include <interfaces.hpp>

Inheritance diagram for CDBParams:

[legend]List of all members.

---

Detailed Description

CDBParams.

Definition at line 145 of file interfaces.hpp.

Public Types
enum	EDirection { eIn, eOut, eInOut }
Public Member Functions
virtual	~CDBParams (void)
virtual unsigned int	GetNum (void) const =0
	Get total number of columns in resultset.
virtual const string &	GetName (const CDBParamVariant &param, CDBParamVariant::ENameFormat format=CDBParamVariant::eSQLServerName) const =0
	Get name of column.
virtual unsigned int	GetIndex (const CDBParamVariant &param) const =0
virtual size_t	GetMaxSize (const CDBParamVariant &param) const =0
	Get maximum size in bytes for column.
virtual EDB_Type	GetDataType (const CDBParamVariant &param) const =0
	Get data type for column in the resultset.
virtual EDirection	GetDirection (const CDBParamVariant &param) const =0
	Get parameter's direction (in/out/inout).
virtual CDBParams &	Bind (const CDBParamVariant &param, CDB_Object *value, bool out_param=false)
	This method stores pointer to data.
virtual CDBParams &	Set (const CDBParamVariant &param, CDB_Object *value, bool out_param=false)
	This method stores copy of data.

---

Member Enumeration Documentation

enum CDBParams::EDirection

Enumerator: eIn  eOut  eInOut  Definition at line 151 of file interfaces.hpp.

---

Constructor & Destructor Documentation

CDBParams::~CDBParams (  void   )  [virtual]

Definition at line 139 of file interfaces.cpp.

---

Member Function Documentation

CDBParams & CDBParams::Bind (  const CDBParamVariant &  param, CDB_Object *  value, bool  out_param = false )  [virtual]

This method stores pointer to data. Parameters: param  Column number or name value  Binded object out_param  true if this parameter is an output parameter Reimplemented in impl::CDBBindedParams. Definition at line 144 of file interfaces.cpp. References DATABASE_DRIVER_ERROR. Referenced by CDB_BCPInCmd::Bind(), CBulkInsert::Bind(), CDB_CursorCmd::BindParam(), CDB_RPCCmd::BindParam(), CDB_LangCmd::BindParam(), and CStatement::ExecuteLast().

virtual EDB_Type CDBParams::GetDataType (  const CDBParamVariant &  param  )  const [pure virtual]

Get data type for column in the resultset. Parameters: param  Column number or name Implemented in impl::CDBBindedParams, and impl::CCachedRowInfo. Referenced by CResultSetMetaData::CResultSetMetaData(), CStatement::CStmtParamsMetaData::GetMaxSize(), CStatement::CStmtParamsMetaData::GetType(), and CDB_Result::ItemDataType().

virtual EDirection CDBParams::GetDirection (  const CDBParamVariant &  param  )  const [pure virtual]

Get parameter's direction (in/out/inout). Parameters: param  Column number or name Implemented in impl::CDBBindedParams, and impl::CCachedRowInfo. Referenced by CStatement::CStmtParamsMetaData::GetDirection().

virtual unsigned int CDBParams::GetIndex (  const CDBParamVariant &  param  )  const [pure virtual]

Parameters: param  Column number or name Returns: Number of a columnn, which is corresponding to a name. Implemented in impl::CDBBindedParams, and impl::CCachedRowInfo.

virtual size_t CDBParams::GetMaxSize (  const CDBParamVariant &  param  )  const [pure virtual]

Get maximum size in bytes for column. Parameters: col  Column number or name Returns: Max number of bytes needed to hold the returned data. Implemented in impl::CDBBindedParams, and impl::CCachedRowInfo. Referenced by CResultSetMetaData::CResultSetMetaData(), and CDB_Result::ItemMaxSize().

virtual const string& CDBParams::GetName (  const CDBParamVariant &  param, CDBParamVariant::ENameFormat  format = CDBParamVariant::eSQLServerName )  const [pure virtual]

Get name of column. This method is returning const reference because meta-info MUST be cached for performance reasons. Parameters: param  Column number or name Implemented in impl::CDBBindedParams, and impl::CCachedRowInfo. Referenced by CResultSetMetaData::CResultSetMetaData(), CStatement::CStmtParamsMetaData::GetName(), and CDB_Result::ItemName().

virtual unsigned int CDBParams::GetNum (  void   )  const [pure virtual]

Get total number of columns in resultset. Returns: total number of columns in resultset Implemented in impl::CDBBindedParams, and impl::CCachedRowInfo. Referenced by CResultSetMetaData::CResultSetMetaData(), CTL_RowResult::Fetch(), CODBC_RowResult::GetColumnNum(), CMySQL_RowResult::GetColumnNum(), CDBL_ResultBase::GetColumnNum(), CTL_RowResult::GetColumnNum(), CStatement::CStmtParamsMetaData::GetTotalColumns(), and CDB_Result::NofItems().

CDBParams & CDBParams::Set (  const CDBParamVariant &  param, CDB_Object *  value, bool  out_param = false )  [virtual]

This method stores copy of data. Parameters: param  Column number or name value  Binded object out_param  true if this parameter is an output parameter Reimplemented in impl::CDBBindedParams. Definition at line 155 of file interfaces.cpp. References DATABASE_DRIVER_ERROR. Referenced by CCallableStatement::SetOutputParam(), CCursor::SetParam(), CCallableStatement::SetParam(), CDB_RPCCmd::SetParam(), and CDB_LangCmd::SetParam().

---

The documentation for this class was generated from the following files:

• include/dbapi/driver/interfaces.hpp
• src/dbapi/driver/interfaces.cpp

---