Proud::CAdoRecordset Class Reference

Inheritance diagram for Proud::CAdoRecordset:

Public Member Functions
	CAdoRecordset (ADODB::_Recordset *rc)
CAdoRecordset &	operator= (ADODB::_Recordset *rc)
PROUDSRV_API bool	GetFieldValue (const String &pszFieldName, String &var)
PROUDSRV_API bool	GetFieldValue (const String &pszFieldName, UUID &var)
PROUDSRV_API bool	GetFieldValue (const String &pszFieldName, COleDateTime &var)
PROUDSRV_API CVariant	GetFieldValue (const String &pszFieldName)
PROUDSRV_API void	SetFieldValue (const String &pszFieldName, const CVariant &value)
PROUDSRV_API CVariant	GetFieldValue (int index)
PROUDSRV_API void	SetFieldValue (int index, const CVariant &value)
PROUDSRV_API _bstr_t	GetFieldNames (int index)
PROUDSRV_API void	Close ()
PROUDSRV_API void	Close_NoThrow ()
bool	IsEOF ()
PROUDSRV_API bool	IsOpened ()
PROUDSRV_API void	Update ()
PROUDSRV_API void	AddNew ()
PROUDSRV_API void	Delete ()
PROUDSRV_API void	Open (ADODB::_Connection *conn, DbOpenFor openFor, const String &queryString)
PROUDSRV_API void	Open (ADODB::_Connection *conn, ADODB::CursorTypeEnum cursorType, ADODB::LockTypeEnum lockType, const String &lpszSQL)
PROUDSRV_API void	Open (void)
PROUDSRV_API void	OpenForUpdate ()
PROUDSRV_API void	CopyFrom (CAdoOfflineRecord &src)
PROUDSRV_API void	MoveNext ()
PROUDSRV_API void	MoveFirst ()
PROUDSRV_API void	MovePrevious ()
PROUDSRV_API void	MoveLast ()
PROUDSRV_API bool	MoveNextRecordset (long *recordsAffected=NULL)
PROUDSRV_API void	NextRecordset (OUT CAdoRecordset &outRecordset, OUT long *recordsAffected=NULL)

Static Public Attributes
static const int	defaultCacheSize = 100

Additional Inherited Members
PROUDSRV_API void	ExecuteBegin ()
PROUDSRV_API void	ExecuteEnd (const String &command)

Detailed Description

ADO Recordset class + some enhanced functions

Use

• Use this method with CAdoConnection.

Member Function Documentation

PROUDSRV_API void Proud::CAdoRecordset::AddNew

(

)

TODO:translate needed. Reserve to add new data

PROUDSRV_API void Proud::CAdoRecordset::Close

(

)

This method obtain name of field.

• It can use 0 based index number as an array factor.

ADODB will be closed.

PROUDSRV_API void Proud::CAdoRecordset::Close_NoThrow

(

)

ADODB will be closed.

• throw will not occur.

PROUDSRV_API void Proud::CAdoRecordset::CopyFrom

(

CAdoOfflineRecord &

src

)

TODO:translate needed. The key value and the value in

Parameters

src	CAdoOfflineRecord is copied one by one.

PROUDSRV_API void Proud::CAdoRecordset::Delete

(

)

TODO:translate needed. Get rid of data

PROUDSRV_API _bstr_t Proud::CAdoRecordset::GetFieldNames

(

int

index

)

Reads and writes field value.

• It can read and write just about any type of data since it use CVariant as parameter.
• It can use field string or 0 based index number as array factor.

bool Proud::CAdoRecordset::IsEOF ( )

inline

TODO:translate needed. Check whether this is the end of the record

Returns

If it is the end, then true, otherwise false.

PROUDSRV_API bool Proud::CAdoRecordset::IsOpened

(

)

TODO:translate needed. Check whether ADODB is in open status.

Returns

If open, true. If close, false.

PROUDSRV_API void Proud::CAdoRecordset::MoveFirst

(

)

This method moves cursor to the initial record

PROUDSRV_API void Proud::CAdoRecordset::MoveLast

(

)

This method moves cursor to the last record.

PROUDSRV_API void Proud::CAdoRecordset::MoveNext

(

)

This method moves cursor to the next record.

PROUDSRV_API bool Proud::CAdoRecordset::MoveNextRecordset

(

long *

recordsAffected = NULL

)

This method moves to the next recordset.

• Assign the next recordset to itself.

  Parameters

  recordsAffected

  Number of records being affected by query

PROUDSRV_API void Proud::CAdoRecordset::MovePrevious

(

)

This method moves cursor to the previous record

PROUDSRV_API void Proud::CAdoRecordset::NextRecordset	(	OUT CAdoRecordset &	outRecordset,
		OUT long *	recordsAffected = NULL
	)

This method passes the next recordset to a different instance.

Parameters

outRecordset	Recordset instance which will receive the next recordset
recordsAffected	Number of records being affected by query

PROUDSRV_API void Proud::CAdoRecordset::Open	(	ADODB::_Connection *	conn,
		DbOpenFor	openFor,
		const String &	queryString
	)

This method opens Recordset.

Parameters

conn	DB Link Object
openFor	OpenForRead: Read Only, OpenForReadWrite, OpenForAppend: Read/Write. The most optimized values for game server use.
lpszSQL	Query Syntax.

PROUDSRV_API void Proud::CAdoRecordset::Open	(	ADODB::_Connection *	conn,
		ADODB::CursorTypeEnum	cursorType,
		ADODB::LockTypeEnum	lockType,
		const String &	lpszSQL
	)

This method opens Recordset.

Parameters

conn	DB Link Object
cursorType	ADODB::CursorTypeEnum
lockType	ADODB::LockTypeEnum
lpszSQL	Query Syntax.

PROUDSRV_API void Proud::CAdoRecordset::Open

(

void

)

This method opens all parameters as default value. This can be used when opening recordset object returned by ADO command.

PROUDSRV_API void Proud::CAdoRecordset::OpenForUpdate

(

)

This method opens all parameters as default value. This can be used when opening recordset object returned by ADO command.

PROUDSRV_API void Proud::CAdoRecordset::Update

(

)

TODO:translate needed. Through DbmsSave function, update the saved data