RVC::DBTABLE::CURSOR Class Reference

Class to represent database table cursors used in ODBC. More...

#include <rvc/dbtable.h>

List of all members.

Public Types
enum	FUNCTION {   FUNCTION_None = 0x00000000, FUNCTION_Unique = 0x00000001, FUNCTION_Sorted = 0x00000002, FUNCTION_Equal = 0x00000004,   FUNCTION_GreaterThan = 0x00000008, FUNCTION_LessThan = 0x00000010, FUNCTION_NotEqual = 0x00000020, FUNCTION_AND = 0x00000040,   FUNCTION_OR = 0x00000080, FUNCTION_NoClear = 0x00000100, FUNCTION_ForUpdate = 0x00000200 }
Public Member Functions
	CURSOR (const RVC::DBTABLE &table)
ERRVALUE	GetBookmark (BOOKMARK &Bookmark) const
INT32	GetRecordNum () const
bool	IsValid () const
int	Next ()
bool	operator== (const CURSOR &rhs) const
ERRVALUE	Rewind ()
ERRVALUE	SetFunction (INT32 FieldNum, FUNCTION Function)
	~CURSOR ()

---

Detailed Description

Class to represent database table cursors used in ODBC.

Definition at line 1104 of file dbtable.h.

---

Member Enumeration Documentation

enum RVC::DBTABLE::CURSOR::FUNCTION

Enumeration values: FUNCTION_None  FUNCTION_Unique  FUNCTION_Sorted  FUNCTION_Equal  FUNCTION_GreaterThan  FUNCTION_LessThan  FUNCTION_NotEqual  FUNCTION_AND  FUNCTION_OR  FUNCTION_NoClear  Add to previous function. FUNCTION_ForUpdate  To allow writes. Definition at line 1106 of file dbtable.h.

---

Constructor & Destructor Documentation

RVC::DBTABLE::CURSOR::CURSOR (  const RVC::DBTABLE &  table  )  [explicit]

Default constructor.

RVC::DBTABLE::CURSOR::~CURSOR (   )

Destructor.

---

Member Function Documentation

ERRVALUE RVC::DBTABLE::CURSOR::GetBookmark (  BOOKMARK &  Bookmark  )  const

Get the current bookmark.

INT32 RVC::DBTABLE::CURSOR::GetRecordNum (   )  const

Get the current record number or < 0 if error.

bool RVC::DBTABLE::CURSOR::IsValid (   )  const

Is the cursor valid. Returns: True for a valid cursor

int RVC::DBTABLE::CURSOR::Next (   )

Increment cursor. Returns: > 0 if still valid, 0 if not, < 0 error

bool RVC::DBTABLE::CURSOR::operator== (  const CURSOR &  rhs  )  const

Equality.

ERRVALUE RVC::DBTABLE::CURSOR::Rewind (   )

Reset cursor to the beginning.

ERRVALUE RVC::DBTABLE::CURSOR::SetFunction (  INT32  FieldNum, FUNCTION  Function )

Set cursor behavior.

---

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

• rvc/dbtable.h

---