#include <Ccdb_ResultSet.h>

Inheritance diagram for dbSpaces::dbcli::ResultSet:

Collaboration diagram for dbSpaces::dbcli::ResultSet:

Public Member Functions
virtual	~ResultSet ()

const dtBOOLEAN	Absolute (dtLARGE)

void	AfterLast ()

void	BeforeFirst ()

void	Close ()

dtRtnStatus	BindColumn (dtULARGE columnIndex, dtSTRING value, dtULARGE length, dtTINY indicator=NULL)

dtRtnStatus	BindColumn (dtULARGE columnIndex, dtUSTRING value, dtULARGE length, dtTINY indicator=NULL)

template<class T >
dtRtnStatus	BindColumn (dtULARGE columnIndex, T value, dtTINY indicator=NULL)

dtRtnStatus	BindColumn (dtSTRING columnLabel, dtSTRING value, dtULARGE length, dtTINY *indicator=NULL)

template<class T >
dtRtnStatus	BindColumn (dtSTRING columnLabel, T value, dtTINY *indicator=NULL)

ResultSetColumnMetaData *	GetColumnMetaData (dtULARGE)

const dtSTRING *	GetCursorName ()

const dtLARGE	GetFetchDirection ()

const dtULARGE	GetFetchSize ()

const dtLARGE	GetFetchType ()

dtULARGE	GetNumberResultColumns ()

const dtULARGE	GetRow ()

Statement *	GetStatement ()

dtRtnStatus	GetValue (dtULARGE columnIndex, dtSTRING value, dtULARGE length, dtTINY indicator=NULL)

dtRtnStatus	GetValue (dtULARGE columnIndex, dtUSTRING value, dtULARGE length, dtTINY indicator=NULL)

template<class T >
dtRtnStatus	GetValue (dtULARGE columnIndex, T value, dtTINY indicator=NULL)

dtRtnStatus	GetValue (dtSTRING columnLabel, dtSTRING value, dtULARGE length, dtTINY *indicator=NULL)

template<class T >
dtRtnStatus	GetValue (dtSTRING columnLabel, T value, dtTINY *indicator=NULL)

const dtBOOLEAN	HasError ()

const dtBOOLEAN	IsAfterLast ()

const dtBOOLEAN	IsBeforeFirst ()

const dtBOOLEAN	IsCachingEnabled ()

const dtBOOLEAN	IsClosed ()

const dtBOOLEAN	IsLast ()

const dtBOOLEAN	Last ()

const dtBOOLEAN	Next ()

const dtBOOLEAN	Previous ()

const dtBOOLEAN	Relative (dtLARGE)

dtRtnStatus	SetCachingEnabled (const dtBOOLEAN=TRUE)

dtRtnStatus	SetFetchSize (dtULARGE)

dtRtnStatus	SetFetchType (const dtLARGE)

dtRtnStatus	SetServerFetchType (const dtLARGE)

Public Member Functions inherited from dbSpaces::dbcli::cdbBase
	cdbBase (cdbBase *, ccdbClassType, dtBOOLEAN=TRUE)

virtual	~cdbBase ()

cdb_childList_t &	GetChildList ()

Ccoms_CommsManager *	GetTransportComms ()

ccdbClassType	GetType ()

void	SetTransportComms (Ccoms_CommsManager *)

Protected Member Functions
dtRtnStatus	BindColumn (dtULARGE, void , DataType &, dtTINY )

void	CleanUpDatasets ()

dtLARGE	Fetch (const dtSMALL, const dtLARGE=0)

void *	GetRequest ()

dtRtnStatus	GetValue (dtULARGE, void , DataType &, dtTINY )

void	Initialise ()

void	SetDatasetHandle (dtHANDLE)

Detailed Description

    A ResultSet provides access to a table of data. 
    A ResultSet object is usually generated by executing a Statement.

    A ResultSet maintains a cursor pointing to its current row of
    data. Initially the cursor is positioned before the first row.
    The 'Next' method moves the cursor to the next row.

    The GetXXX methods retrieve column values for the current
    row. You can retrieve values either using the index number of the
    column, or by using the name of the column. In general using the
    column index will be more efficient. Columns are numbered from 1.

    For maximum portability, ResultSet columns within each row should be
    read in left-to-right order and each column should be read only once.

    Column names used as input to GetXXX methods are case
    insensitive.  When performing a GetXXX using a column name, if
    several columns have the same name, then the value of the first
    matching column will be returned. The column name option is
    designed to be used when column names are used in the SQL
    query. For columns that are NOT explicitly named in the query, it
    is best to use column numbers. If column names were used there is
    no way for the programmer to guarantee that they actually refer to
    the intended columns.

    A ResultSet is automatically closed by the Statement that
    generated it when that Statement is closed, re-executed, or is used
    to retrieve the next result from a sequence of multiple results.

    The number, types and properties of a ResultSet's columns are
    provided by the ResultSetColumnMetaData object returned by the 
    <code>GetColumnMetaData()</code> method.

    A DatabaseException will be thrown if a database error occurs and exceptions 
    are enabled. If exceptions are not enabled the following error methods can
    be used to get information about the error;
    <ul>
    <li>GetErrorStatus()
    <li>GetErrorCode()
    <li>GetErrorMessage()
    </ul>

    @see Statement::Execute()

See also: ResultSetColumnMetaData()

Since: Version 1.0

Constructor & Destructor Documentation

◆ ~ResultSet()

virtual dbSpaces::dbcli::ResultSet::~ResultSet ( )

virtual

Destructor.

Since: Version 1.0

Member Function Documentation

◆ Absolute()

const dtBOOLEAN dbSpaces::dbcli::ResultSet::Absolute ( dtLARGE )

Moves the cursor to the given row number in this ResultSet object.

If the row number is positive, the cursor moves to the given row number with respect to the beginning of the result set. The first row is row 1, the second is row 2, and so on.

If the given row number is negative, the cursor moves to an absolute row position with respect to the end of the result set. For example, calling the method absolute(-1) positions the cursor on the last row; calling the method absolute(-2) moves the cursor to the next-to-last row, and so on.

An attempt to position the cursor beyond the first/last row in the result set leaves the cursor before the first row or after the last row.

Note: Calling absolute(1) is the same as calling first(). Calling absolute(-1) is the same as calling last().

Parameters

row	The number of the row to which the cursor should move. A positive number indicates the row number counting from the beginning of the result set; a negative number indicates the row number counting from the end of the result set

Returns: TRUE if the cursor is moved to a position in this ResultSet object; FALSE if the cursor is before the first row or after the last row

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs; this method is called on a closed result set or the result set type is RESULTSET_TYPE_FORWARD_ONLY.

Since: Version 1.0

◆ AfterLast()

void dbSpaces::dbcli::ResultSet::AfterLast ( )

Moves the cursor to the end of this ResultSet object, just after the last row. This method has no effect if the result set contains no rows.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs; this method is called on a closed result set or the result set type is RESULTSET_TYPE_FORWARD_ONLY

Since: Version 1.0

◆ BeforeFirst()

void dbSpaces::dbcli::ResultSet::BeforeFirst ( )

Moves the cursor to the front of this ResultSet object, just before the first row. This method has no effect if the result set contains no rows.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs; this method is called on a closed result set or the result set type is RESULTSET_TYPE_FORWARD_ONLY

Since: Version 1.0

◆ BindColumn() [1/6]

dtRtnStatus dbSpaces::dbcli::ResultSet::BindColumn	(	dtSTRING *	columnLabel,
		dtSTRING *	value,
		dtULARGE	length,
		dtTINY *	indicator = `NULL`
	)

inline

Bind a program variable to the column. Bound columns have their variables populated with data when rows are fetched from the database.

If the column is a multi-value (array) then the value and indicator variables should be large enough to contain all multi-values.

For example, if the storage class is a dtLARGE (size of 4 bytes) and the column has 2 multi-values, then value will be 8 bytes in size. The first 4 bytes contains the first value and the second 4 bytes contains the second value. Similarly for indicator its size will be 2 bytes, the first byte contains the indicator value for the first value and the second byte contains the indicator value for the second value.

Parameters

columnLabel	The column label.
value	Value(s) address.
length	The length in bytes of the value.
indicator	Indicator(s) address used to indicate NOT NULL or NULL data. Possible indicator values are; 1 - (CTYPE_NOT_NULL) not null data. 2 - (CTYPE_NULL) null data.

Note: The indicator parameter is optional.

Returns: RTN_STATUS_SUCCESS or RTN_STATUS_ERROR.

Since: Version 1.0

◆ BindColumn() [2/6]

template<class T >

dtRtnStatus dbSpaces::dbcli::ResultSet::BindColumn	(	dtSTRING *	columnLabel,
		T *	value,
		dtTINY *	indicator = `NULL`
	)

inline

Bind a program variable to the column. Bound columns have their variables populated with data when rows are fetched from the database.

If the column is a multi-value (array) then the value and indicator variables should be large enough to contain all multi-values.

For example, if the storage class is a dtLARGE (size of 4 bytes) and the column has 2 multi-values, then value will be 8 bytes in size. The first 4 bytes contains the first value and the second 4 bytes contains the second value. Similarly for indicator its size will be 2 bytes, the first byte contains the indicator value for the first value and the second byte contains the indicator value for the second value.

Parameters

columnLabel	The column label.
value	Value(s) address.
indicator	Indicator(s) address used to indicate NOT NULL or NULL data. Possible indicator values are; 1 - (CTYPE_NOT_NULL) not null data. 2 - (CTYPE_NULL) null data.

Note: The indicator parameter is optional.

Returns: RTN_STATUS_SUCCESS or RTN_STATUS_ERROR.

Since: Version 1.0

◆ BindColumn() [3/6]

dtRtnStatus dbSpaces::dbcli::ResultSet::BindColumn	(	dtULARGE	columnIndex,
		dtSTRING *	value,
		dtULARGE	length,
		dtTINY *	indicator = `NULL`
	)

inline

Bind a program variable to the column. Bound columns have their variables populated with data when rows are fetched from the database.

If the column is a multi-value (array) then the value and indicator variables should be large enough to contain all multi-values.

For example, if the storage class is a dtLARGE (size of 4 bytes) and the column has 2 multi-values, then value will be 8 bytes in size. The first 4 bytes contains the first value and the second 4 bytes contains the second value. Similarly for indicator its size will be 2 bytes, the first byte contains the indicator value for the first value and the second byte contains the indicator value for the second value.

Parameters

columnIndex	The column index (ordinal position) starting from 1.
value	Value(s) address.
length	The length in bytes of the value.
indicator	Indicator(s) address used to indicate NOT NULL or NULL data. Possible indicator values are; 1 - (CTYPE_NOT_NULL) not null data. 2 - (CTYPE_NULL) null data.

Note: The indicator parameter is optional.

Returns: RTN_STATUS_SUCCESS or RTN_STATUS_ERROR.

Since: Version 1.0

◆ BindColumn() [4/6]

dtRtnStatus dbSpaces::dbcli::ResultSet::BindColumn	(	dtULARGE	columnIndex,
		dtUSTRING *	value,
		dtULARGE	length,
		dtTINY *	indicator = `NULL`
	)

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Since: Version 1.0

◆ BindColumn() [5/6]

template<class T >

dtRtnStatus dbSpaces::dbcli::ResultSet::BindColumn	(	dtULARGE	columnIndex,
		T *	value,
		dtTINY *	indicator = `NULL`
	)

inline

Bind a program variable to the column. Bound columns have their variables populated with data when rows are fetched from the database.

If the column is a multi-value (array) then the value and indicator variables should be large enough to contain all multi-values.

For example, if the storage class is a dtLARGE (size of 4 bytes) and the column has 2 multi-values, then value will be 8 bytes in size. The first 4 bytes contains the first value and the second 4 bytes contains the second value. Similarly for indicator its size will be 2 bytes, the first byte contains the indicator value for the first value and the second byte contains the indicator value for the second value.

Parameters

columnIndex	The column index (ordinal position) starting from 1.
value	Value(s) address.
indicator	Indicator(s) address used to indicate NOT NULL or NULL data. Possible indicator values are; 1 - (CTYPE_NOT_NULL) not null data. 2 - (CTYPE_NULL) null data.

Note: The indicator parameter is optional.

Returns: RTN_STATUS_SUCCESS or RTN_STATUS_ERROR.

Since: Version 1.0

◆ BindColumn() [6/6]

dtRtnStatus dbSpaces::dbcli::ResultSet::BindColumn	(	dtULARGE	,
		void *	,
		DataType &	,
		dtTINY *
	)

protected

◆ CleanUpDatasets()

void dbSpaces::dbcli::ResultSet::CleanUpDatasets ( )

protected

◆ Close()

void dbSpaces::dbcli::ResultSet::Close ( )

Releases this ResultSet object's database and local resources immediately instead of waiting for this to happen when it is automatically closed.

Note: A ResultSet object is automatically closed by the Statement object that generated it when that Statement object is closed, re-executed, or is used to retrieve the next result from a sequence of multiple results.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs.

Since: Version 1.0

◆ Fetch()

dtLARGE dbSpaces::dbcli::ResultSet::Fetch	(	const	dtSMALL,
		const	dtLARGE = `0`
	)

protected

◆ GetColumnMetaData()

ResultSetColumnMetaData * dbSpaces::dbcli::ResultSet::GetColumnMetaData ( dtULARGE )

Get a ResultSetColumnMetaData object based on the ResultSet column ordinal position.

Parameters

columnIndex - column index (ordinal position) starting from 1.

See also: ResultSetColumnMetaData.

Since: Version 1.0

◆ GetCursorName()

const dtSTRING * dbSpaces::dbcli::ResultSet::GetCursorName ( )

Get the cursor name for the ResultSet object.

Returns: The cursor name.

Since: Version 1.0

◆ GetFetchDirection()

const dtLARGE dbSpaces::dbcli::ResultSet::GetFetchDirection ( )

Retrieves the fetch direction for this ResultSet object.

Returns: The current fetch direction for this ResultSet object.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs or this method is called on a closed result set.

See also: setFetchDirection()

Since: Version 1.0

◆ GetFetchSize()

const dtULARGE dbSpaces::dbcli::ResultSet::GetFetchSize ( )

Get the fetch size for this ResultSet object.

Returns: The current fetch size for this ResultSet object

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs or this method is called on a closed result set.

See also: setFetchSize()

Since: Version 1.0

◆ GetFetchType()

const dtLARGE dbSpaces::dbcli::ResultSet::GetFetchType ( )

Get the fetch type for this ResultSet object.

Returns: RESULTSET_TYPE_FORWARD_ONLY or RESULTSET_TYPE_SCROLL_INSENSITIVE.

Since: Version 1.0

◆ GetNumberResultColumns()

dtULARGE dbSpaces::dbcli::ResultSet::GetNumberResultColumns ( )

Get the number of columns that make up the ResultSet.

Returns: The number of columns.

Since: Version 1.0

◆ GetRequest()

void * dbSpaces::dbcli::ResultSet::GetRequest ( )

protected

◆ GetRow()

const dtULARGE dbSpaces::dbcli::ResultSet::GetRow ( )

Retrieves the current row number. The first row is number 1, the second number 2, and so on.

Note:Support for the getRow method is optional for ResultSets with a result set type of RESULTSET_TYPE_FORWARD_ONLY

Returns: The current row number; 0 if there is no current row

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs or this method is called on a closed result set.

Since: Version 1.0

◆ GetStatement()

Statement * dbSpaces::dbcli::ResultSet::GetStatement ( )

Get ResultSet's parent Statement object.

Returns: The Statement object.

Since: Version 1.0

◆ GetValue() [1/6]

dtRtnStatus dbSpaces::dbcli::ResultSet::GetValue	(	dtSTRING *	columnLabel,
		dtSTRING *	value,
		dtULARGE	length,
		dtTINY *	indicator = `NULL`
	)

inline

Get the value of the ResultSet column in the variable provided.

Parameters

columnLabel	The column index (ordinal position) starting from 1.
value	The program variable address to return the column value into (output).
length	The length of the program variable in bytes.
indicator	The program variable address to return the column indicator value into (output).

Returns: RTN_STATUS_SUCCESS or RTN_STATUS_ERROR.

See also: BindColumn()

Since: Version 1.0

◆ GetValue() [2/6]

template<class T >

dtRtnStatus dbSpaces::dbcli::ResultSet::GetValue	(	dtSTRING *	columnLabel,
		T *	value,
		dtTINY *	indicator = `NULL`
	)

inline

Get the value of the ResultSet column in the variable provided.

Parameters

columnLabel	The column index (ordinal position) starting from 1.
value	The program variable address to return the column value into (output).
indicator	The program variable address to return the column indicator value into (output).

Returns: RTN_STATUS_SUCCESS or RTN_STATUS_ERROR.

See also: BindColumn()

Since: Version 1.0

◆ GetValue() [3/6]

dtRtnStatus dbSpaces::dbcli::ResultSet::GetValue	(	dtULARGE	columnIndex,
		dtSTRING *	value,
		dtULARGE	length,
		dtTINY *	indicator = `NULL`
	)

inline

Get the value of the ResultSet column in the variable provided.

Parameters

columnIndex	The column index (ordinal position) starting from 1.
value	The program variable address to return the column value into (output).
length	The length of the program variable in bytes.
indicator	The program variable address to return the column indicator value into (output).

Returns: RTN_STATUS_SUCCESS or RTN_STATUS_ERROR.

See also: BindColumn()

Since: Version 1.0

◆ GetValue() [4/6]

dtRtnStatus dbSpaces::dbcli::ResultSet::GetValue	(	dtULARGE	columnIndex,
		dtUSTRING *	value,
		dtULARGE	length,
		dtTINY *	indicator = `NULL`
	)

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Since: Version 1.0

◆ GetValue() [5/6]

template<class T >

dtRtnStatus dbSpaces::dbcli::ResultSet::GetValue	(	dtULARGE	columnIndex,
		T *	value,
		dtTINY *	indicator = `NULL`
	)

inline

Get the value of the ResultSet column in the variable provided.

Parameters

columnIndex	The column index (ordinal position) starting from 1.
value	The program variable address to return the column value into (output).
indicator	The program variable address to return the column indicator value into (output).

Returns: RTN_STATUS_SUCCESS or RTN_STATUS_ERROR.

See also: BindColumn()

Since: Version 1.0

◆ GetValue() [6/6]

dtRtnStatus dbSpaces::dbcli::ResultSet::GetValue	(	dtULARGE	,
		void *	,
		DataType &	,
		dtTINY *
	)

protected

◆ HasError()

const dtBOOLEAN dbSpaces::dbcli::ResultSet::HasError ( )

Checks if a ResultSet request has resulted in an error.

Returns: TRUE if an error exists, otherwise FALSE.

Since: Version 1.0

◆ Initialise()

void dbSpaces::dbcli::ResultSet::Initialise ( )

protected

◆ IsAfterLast()

const dtBOOLEAN dbSpaces::dbcli::ResultSet::IsAfterLast ( )

Retrieves whether the cursor is after the last row in this ResultSet object.

Note:Support for the isAfterLast method is optional for ResultSets with a result set type of RESULTSET_TYPE_FORWARD_ONLY

Returns: TRUE if the cursor is after the last row; FALSE if the cursor is at any other position or the result set contains no rows.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs or this method is called on a closed result set.

Since: Version 1.0

◆ IsBeforeFirst()

const dtBOOLEAN dbSpaces::dbcli::ResultSet::IsBeforeFirst ( )

Retrieves whether the cursor is before the first row in this ResultSet object.

Note:Support for the isBeforeFirst method is optional for ResultSets with a result set type of RESULTSET_TYPE_FORWARD_ONLY

Returns: TRUE if the cursor is before the first row; FALSE if the cursor is at any other position or the result set contains no rows

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs or this method is called on a closed result set.

Since: Version 1.0

◆ IsCachingEnabled()

const dtBOOLEAN dbSpaces::dbcli::ResultSet::IsCachingEnabled ( )

Is the ResultSet cached locally?

Returns: TRUE if caching is enabled; FALSE if otherwise.

See also: SetCachingEnabled()

Since: Version 1.0

◆ IsClosed()

const dtBOOLEAN dbSpaces::dbcli::ResultSet::IsClosed ( )

Retrieves whether this ResultSet object has been closed. A ResultSet is closed if the method close has been called on it, or if it is automatically closed.

Returns: TRUE if this ResultSet object is closed; FALSE if it is still open.

Since: Version 1.0

◆ IsLast()

const dtBOOLEAN dbSpaces::dbcli::ResultSet::IsLast ( )

Retrieves whether the cursor is on the last row of this ResultSet object.

Returns: TRUE if the cursor is on the last row; FALSE if otherwise.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs or this method is called on a closed result set

Since: Version 1.0

◆ Last()

const dtBOOLEAN dbSpaces::dbcli::ResultSet::Last ( )

Moves the cursor to the last row in this ResultSet object.

Returns: TRUE if the cursor is on a valid row; FALSE if there are no rows in the result set.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs; this method is called on a closed result set or the result set type is RESULTSET_TYPE_FORWARD_ONLY

Since: Version 1.0

◆ Next()

const dtBOOLEAN dbSpaces::dbcli::ResultSet::Next ( )

A ResultSet is initially positioned before its first row; the first call to next makes the first row the current row; the second call makes the second row the current row, etc.

Returns: TRUE if the new current row is valid; FALSE if there are no more rows.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs.

Since: Version 1.0

◆ Previous()

const dtBOOLEAN dbSpaces::dbcli::ResultSet::Previous ( )

Moves the cursor to the previous row in this ResultSet object.

When a call to the previous method returns false, the cursor is positioned before the first row. Any invocation of a ResultSet method which requires a current row will result in a DatabaseException being thrown.

If an input stream is open for the current row, a call to the method previous will implicitly close it. A ResultSet object's warning change is cleared when a new row is read.

Returns: TRUE if the cursor is now positioned on a valid row; FALSE if the cursor is positioned before the first row.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs; this method is called on a closed result set or the result set type is RESULT_TYPE_FORWARD_ONLY.

Since: Version 1.0

◆ Relative()

const dtBOOLEAN dbSpaces::dbcli::ResultSet::Relative ( dtLARGE )

Moves the cursor a relative number of rows, either positive or negative. Attempting to move beyond the first/last row in the result set positions the cursor before/after the the first/last row. Calling relative(0) is valid, but does not change the cursor position.

Note: Calling the method relative(1) is identical to calling the method next() and calling the method relative(-1) is identical to calling the method previous().

Parameters

rows	An `int` specifying the number of rows to move from the current row; a positive number moves the cursor forward; a negative number moves the cursor backward

Returns: TRUE if the cursor is on a row; FALSE if otherwise.

Exceptions

DatabaseException if a database access error occurs; this method is called on a closed result set or the result set type is RESULTSET_TYPE_FORWARD_ONLY

Since: Version 1.0

◆ SetCachingEnabled()

dtRtnStatus dbSpaces::dbcli::ResultSet::SetCachingEnabled ( const dtBOOLEAN = TRUE )

Enable or disable the ability of the ResultSet to cache rows locally. Caching can only be enabled before any rows are fetched.

Parameters

enable TRUE to enable caching; FALSE if otherwise.

Returns: RTN_STATUS_SUCCESS or RTN_STATUS_ERROR.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs.

Since: Version 1.0

◆ SetDatasetHandle()

void dbSpaces::dbcli::ResultSet::SetDatasetHandle ( dtHANDLE )

protected

◆ SetFetchSize()

dtRtnStatus dbSpaces::dbcli::ResultSet::SetFetchSize ( dtULARGE )

Set the fetch size when fetching the ResultSet rows from the server.

Parameters

size	The number rows to fetch.

Returns: RTN_STATUS_SUCCESS or RTN_STATUS_ERROR.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs.

Since: Version 1.0

◆ SetFetchType()

dtRtnStatus dbSpaces::dbcli::ResultSet::SetFetchType ( const dtLARGE )

Set the fetch type for the ResultSet. The supported fetch types currently supported are; RESULTSET_TYPE_FORWARD_ONLY - cursor can move forward only RESULTSET_TYPE_SCROLL_INSENSITIVE - cursor can move in any direction

The default fetch type for the ResultSet object is forward only.

Parameters

fetchType The new fetch type.

Returns: RTN_STATUS_SUCCESS or RTN_STATUS_ERROR.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs.

See also: GetFetchType().

Since: Version 1.0

◆ SetServerFetchType()

dtRtnStatus dbSpaces::dbcli::ResultSet::SetServerFetchType ( const dtLARGE )

Set the server fetch type for the ResultSet. The supported fetch types currently supported are; RESULTSET_TYPE_FORWARD_ONLY - cursor can move forward only RESULTSET_TYPE_SCROLL_INSENSITIVE - cursor can move in any direction

The default fetch type for the ResultSet object is forward only.

Parameters

fetchType The new fetch type.

Returns: RTN_STATUS_SUCCESS or RTN_STATUS_ERROR.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs.

See also: GetFetchType().

Since: Version 1.0

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~ResultSet()

Member Function Documentation

◆ Absolute()

◆ AfterLast()

◆ BeforeFirst()

◆ BindColumn() [1/6]

◆ BindColumn() [2/6]

◆ BindColumn() [3/6]

◆ BindColumn() [4/6]

◆ BindColumn() [5/6]

◆ BindColumn() [6/6]

◆ CleanUpDatasets()

◆ Close()

◆ Fetch()

◆ GetColumnMetaData()

◆ GetCursorName()

◆ GetFetchDirection()

◆ GetFetchSize()

◆ GetFetchType()

◆ GetNumberResultColumns()

◆ GetRequest()

◆ GetRow()

◆ GetStatement()

◆ GetValue() [1/6]

◆ GetValue() [2/6]

◆ GetValue() [3/6]

◆ GetValue() [4/6]

◆ GetValue() [5/6]

◆ GetValue() [6/6]

◆ HasError()

◆ Initialise()

◆ IsAfterLast()

◆ IsBeforeFirst()

◆ IsCachingEnabled()

◆ IsClosed()

◆ IsLast()

◆ Last()

◆ Next()

◆ Previous()

◆ Relative()

◆ SetCachingEnabled()

◆ SetDatasetHandle()

◆ SetFetchSize()

◆ SetFetchType()

◆ SetServerFetchType()