pqxx::cursor_base Class Reference

Common definitions for cursor types. More...

#include <cursor.hxx>

Inheritance diagram for pqxx::cursor_base:

List of all members.

Public Types
typedef result::size_type	size_type
typedef result::difference_type	difference_type
Public Member Functions
	operator void * () const
	Does it make sense to try reading from this cursor again?
bool	operator! () const
	Is this cursor finished?
const PGSTD::string &	name () const throw ()
	Name of underlying SQL cursor.
Static Public Member Functions
difference_type	all () throw ()
	Special value: read until end.
difference_type	next () throw ()
	Special value: read one row only.
difference_type	prior () throw ()
	Special value: read backwards, one row only.
difference_type	backward_all () throw ()
	Special value: read backwards from current position back to origin.
Protected Member Functions
	cursor_base (transaction_base *, const PGSTD::string &cname, bool embellish_name=true)
Protected Attributes
transaction_base *	m_context
bool	m_done

---

Detailed Description

Common definitions for cursor types.

---

Member Typedef Documentation

typedef result::difference_type pqxx::cursor_base::difference_type

typedef result::size_type pqxx::cursor_base::size_type

---

Constructor & Destructor Documentation

pqxx::cursor_base::cursor_base (  transaction_base *  , const PGSTD::string &  cname, bool  embellish_name = true )  [protected]

---

Member Function Documentation

cursor_base::difference_type pqxx::cursor_base::all (   )  throw () [static]

Special value: read until end. Returns: Maximum value for result::difference_type, so the cursor will attempt to read the largest possible result set.

cursor_base::difference_type pqxx::cursor_base::backward_all (   )  throw () [static]

Special value: read backwards from current position back to origin. Returns: Minimum value for result::difference_type

const PGSTD::string& pqxx::cursor_base::name (   )  const throw ()

Name of underlying SQL cursor. Returns: Name of SQL cursor, which may differ from the given name. Warning: Don't use this to access the SQL cursor directly without going through the provided wrapper classes!

difference_type pqxx::cursor_base::next (   )  throw () [static]

Special value: read one row only. Returns: Unsurprisingly, 1

pqxx::cursor_base::operator void * (   )  const

Does it make sense to try reading from this cursor again? Returns: Null pointer if finished, non-null if not

bool pqxx::cursor_base::operator! (   )  const

Is this cursor finished? The logical negation of the converstion-to-pointer operator. Returns: Whether the last attempt to read failed

difference_type pqxx::cursor_base::prior (   )  throw () [static]

Special value: read backwards, one row only. Returns: Unsurprisingly, -1

---

Member Data Documentation

transaction_base* pqxx::cursor_base::m_context [protected]

bool pqxx::cursor_base::m_done [protected]

---

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

• cursor.hxx
• cursor.cxx

---