SequoiaDB
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | Public Attributes | List of all members
sdbclient::sdbCursor Class Reference

Database operation interfaces of cursor. More...

#include <client.hpp>

Public Member Functions

 sdbCursor ()
 default constructor
 
 ~sdbCursor ()
 destructor
 
INT32 next (bson::BSONObj &obj)
 Return the next document of current cursor, and move forward.
 
INT32 current (bson::BSONObj &obj)
 Return the current document of cursor, and don't move.
 
INT32 close ()
 Close the cursor's connection to database.
 

Public Attributes

_sdbCursorpCursor
 

Detailed Description

Database operation interfaces of cursor.

Member Function Documentation

INT32 sdbclient::sdbCursor::close ( )
inline

Close the cursor's connection to database.

Return values
SDB_OKOperation Success
OthersOperation Fail
INT32 sdbclient::sdbCursor::current ( bson::BSONObj &  obj)
inline

Return the current document of cursor, and don't move.

Parameters
[out]objThe return bson object
Return values
SDB_OKOperation Success
OthersOperation Fail
INT32 sdbclient::sdbCursor::next ( bson::BSONObj &  obj)
inline

Return the next document of current cursor, and move forward.

Parameters
[out]objThe return bson object
Return values
SDB_OKOperation Success
OthersOperation Fail

Member Data Documentation

sdbclient::sdbCursor::pCursor

A pointer of virtual base class _sdbCursor

Class sdbCursor is a shell for _sdbCursor. We use pCursor to call the methods in class _sdbCursor.


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