#include <dbapi/driver/impl/dbapi_impl_result.hpp>

Inheritance diagram for impl::CResult:

Collaboration diagram for impl::CResult:

Public Member Functions
	CResult (void)

virtual	~CResult (void)

virtual EDB_ResType	ResultType (void) const =0
	Get type of the result. More...

virtual const CDBParams &	GetDefineParams (void) const

virtual bool	Fetch (void)=0
	Fetch next row. More...

virtual int	CurrentItemNo (void) const =0
	Return current item number we can retrieve (0,1,...) Return "-1" if no more items left (or available) to read. More...

virtual int	GetColumnNum (void) const =0
	Return number of columns in the recordset. More...

virtual CDB_Object *	GetItem (CDB_Object *item_buf=0, I_Result::EGetItem policy=I_Result::eAppendLOB)=0
	Get a result item (you can use either GetItem or ReadItem). More...

virtual size_t	ReadItem (void buffer, size_t buffer_size, bool is_null=0)=0
	Read a result item body (for BLOB columns, mostly). More...

virtual I_BlobDescriptor *	GetBlobDescriptor (void)=0
	Get a descriptor for a BLOB column (for SendData). More...

I_BlobDescriptor *	GetImageOrTextDescriptor (void)

virtual bool	SkipItem (void)=0
	Skip result item. More...

void	AttachTo (CDB_Result *interface)

const CDB_Params &	GetDefineParamsImpl (void) const

CDB_Params &	GetDefineParamsImpl (void)

Protected Attributes
CDB_Params	m_DefineParams

CCachedRowInfo	m_CachedRowInfo

Private Member Functions
void	Release (void)

void	DetachInterface (void)

Private Attributes
CInterfaceHook< CDB_Result >	m_Interface

Friends
class	ncbi::CDB_Result

Detailed Description

CResult::

Definition at line 48 of file dbapi_impl_result.hpp.

Constructor & Destructor Documentation

◆ CResult()

CResult::CResult ( void )

Definition at line 44 of file dbapi_impl_result.cpp.

◆ ~CResult()

CResult::~CResult ( void )

virtual

Definition at line 50 of file dbapi_impl_result.cpp.

References DetachInterface(), NCBI_CATCH_ALL_X, and NCBI_CURRENT_FUNCTION.

Member Function Documentation

◆ AttachTo()

void impl::CResult::AttachTo ( CDB_Result * interface )

inline

Definition at line 98 of file dbapi_impl_result.hpp.

References m_Interface.

Referenced by CDB_Result::CDB_Result().

◆ CurrentItemNo()

virtual int impl::CResult::CurrentItemNo ( void ) const

pure virtual

Return current item number we can retrieve (0,1,...) Return "-1" if no more items left (or available) to read.

Implemented in CODBC_CursorResult, CODBC_RowResult, CTL_CursorResultExpl, CTL_RowResult, and CMySQL_RowResult.

Referenced by CDB_Result::CurrentItemNo().

◆ DetachInterface()

void impl::CResult::DetachInterface ( void )

inlineprivate

Definition at line 123 of file dbapi_impl_result.hpp.

References CInterfaceHook< I >::DetachInterface(), and m_Interface.

Referenced by Release(), and ~CResult().

◆ Fetch()

virtual bool impl::CResult::Fetch ( void )

pure virtual

Fetch next row.

Implemented in CODBC_CursorResultExpl, CODBC_CursorResult, CODBC_RowResult, CTL_CursorResultExpl, CTL_CursorResult, CTL_RowResult, and CMySQL_RowResult.

Referenced by CDB_Result::Fetch().

◆ GetBlobDescriptor()

virtual I_BlobDescriptor* impl::CResult::GetBlobDescriptor ( void )

pure virtual

Get a descriptor for a BLOB column (for SendData).

Return NULL if this result doesn't (or can't) have a BLOB descriptor. NOTE: you need to call ReadItem (maybe even with buffer_size == 0) before calling this method!

Implemented in CODBC_CursorResult, CODBC_RowResult, CTL_CursorResultExpl, CTL_RowResult, and CMySQL_RowResult.

Referenced by CDB_Result::GetBlobDescriptor(), and GetImageOrTextDescriptor().

◆ GetColumnNum()

virtual int impl::CResult::GetColumnNum ( void ) const

pure virtual

Return number of columns in the recordset.

Implemented in CODBC_CursorResult, CODBC_RowResult, CMySQL_RowResult, CTL_CursorResultExpl, and CTL_RowResult.

Referenced by CDB_Result::GetColumnNum().

◆ GetDefineParams()

const CDBParams & CResult::GetDefineParams ( void ) const

virtual

◆ GetDefineParamsImpl() [1/2]

CDB_Params& impl::CResult::GetDefineParamsImpl ( void )

inline

Definition at line 107 of file dbapi_impl_result.hpp.

References m_DefineParams.

◆ GetDefineParamsImpl() [2/2]

const CDB_Params& impl::CResult::GetDefineParamsImpl ( void ) const

inline

Definition at line 103 of file dbapi_impl_result.hpp.

References m_DefineParams.

◆ GetImageOrTextDescriptor()

I_BlobDescriptor* impl::CResult::GetImageOrTextDescriptor ( void )

inline

Definition at line 92 of file dbapi_impl_result.hpp.

References GetBlobDescriptor().

◆ GetItem()

virtual CDB_Object* impl::CResult::GetItem	(	CDB_Object *	item_buf = `0`,
		I_Result::EGetItem	policy = `I_Result::eAppendLOB`
	)

pure virtual

Get a result item (you can use either GetItem or ReadItem).

If "item_buf" is not NULL, then use "*item_buf" (its type should be compatible with the type of retrieved item!) to retrieve the item to; otherwise allocate new "CDB_Object".

Implemented in CODBC_CursorResult, CTL_CursorResultExpl, CODBC_RowResult, CMySQL_RowResult, and CTL_RowResult.

Referenced by CDB_Result::GetItem().