Table of data representing a database result set. More...

#include <resultSet.h>

Data Fields
_NuoDB_ResultSet_state_t *	_state

NuoDB_Status(*	close )(NuoDB_ResultSet *_this)
	Close the result set on the server side.

NuoDB_Status(*	findColumn )(NuoDB_ResultSet _this, const char columnLabel, int *position)
	Find the position of a column in a result set.

NuoDB_Status(*	getBoolean )(NuoDB_ResultSet _this, int column, nuodb_bool_t boolPtr)
	Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structure as a pointer to a nuodb_bool_t type.

NuoDB_Status(*	getBooleanByLabel )(NuoDB_ResultSet _this, const char columnLabel, nuodb_bool_t *boolPtr)
	Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structure as a pointer to a nuodb_bool_t type.

NuoDB_Status(*	getByte )(NuoDB_ResultSet _this, int column, char charPtr)
	Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structure as a pointer to a char.

NuoDB_Status(*	getByteByLabel )(NuoDB_ResultSet _this, const char columnLabel, char *charPtr)
	Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structure as a pointer to a char.

NuoDB_Status(*	getBytes )(NuoDB_ResultSet _this, int column, size_t length, const char **bytes)
	Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structure as a pointer to a binary string.

NuoDB_Status(*	getBytesByLabel )(NuoDB_ResultSet _this, const char columnLabel, size_t length, const char *bytes)
	Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structure as a pointer to a string.

NuoDB_Status(*	getDouble )(NuoDB_ResultSet _this, int column, double doublePtr)
	Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structure as a pointer to a double.

NuoDB_Status(*	getDoubleByLabel )(NuoDB_ResultSet _this, const char columnLabel, double *doublePtr)
	Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structure as a pointer to a double.

NuoDB_Status(*	getInt )(NuoDB_ResultSet _this, int column, int32_t intPtr)
	Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structure as a pointer to a int32_t.

NuoDB_Status(*	getIntByLabel )(NuoDB_ResultSet _this, const char columnLabel, int32_t *intPtr)
	Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structure as a pointer to a int32_t.

NuoDB_Status(*	getLob )(NuoDB_ResultSet _this, int column, NuoDB_Lob_Type lobType, NuoDB_Lob *lobPtr)
	Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structure as a pointer to a NuoDB_Lob data structure.

NuoDB_Status(*	getLobByLabel )(NuoDB_ResultSet _this, const char columnLabel, NuoDB_Lob_Type lobType, NuoDB_Lob **lobPtr)
	Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structure as a pointer to a NuoDB_Lob data structure.

NuoDB_Status(*	getLong )(NuoDB_ResultSet _this, int column, int64_t longPtr)
	Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structure as a pointer to a long.

NuoDB_Status(*	getLongByLabel )(NuoDB_ResultSet _this, const char columnLabel, int64_t *longPtr)
	Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structure as a pointer to a long.

NuoDB_ResultSetMetaData (	getMetaData )(NuoDB_ResultSet *_this)
	Retrieves the number, types and properties of specified NuoDB_ResultSet's columns.

int(*	getNumberColumns )(NuoDB_ResultSet *_this)
	Returns the number of columns.

NuoDB_Status(*	getShort )(NuoDB_ResultSet _this, int column, short shortPtr)
	Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structure as a pointer to a short.

NuoDB_Status(*	getShortByLabel )(NuoDB_ResultSet _this, const char columnLabel, short *shortPtr)
	Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structure as a pointer to a short.

NuoDB_Status(*	getString )(NuoDB_ResultSet _this, int column, const char *strPtr)
	Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structure as a pointer to a string data structure.

NuoDB_Status(*	getStringByLabel )(NuoDB_ResultSet _this, const char columnLabel, const char **strPtr)
	Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structure as a pointer to a string data structure.

NuoDB_Status(*	getStringWithLength )(NuoDB_ResultSet _this, int column, size_t length, const char **strPtr)
	Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structure as a pointer to a string data structure.

NuoDB_Status(*	getStringWithLengthByLabel )(NuoDB_ResultSet _this, const char columnLabel, size_t length, const char *strPtr)
	Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structure as a pointer to a string data structure.

NuoDB_Status(*	getTemporal )(NuoDB_ResultSet _this, int column, NuoDB_Temporal_Type temporalType, NuoDB_Temporal *temporalPtr)
	Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structure as a pointer to a NuoDB_Temporal data structure.

NuoDB_Status(*	getTemporalByLabel )(NuoDB_ResultSet _this, const char columnLabel, NuoDB_Temporal_Type temporalType, NuoDB_Temporal **temporalPtr)
	Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structure as a pointer to a NuoDB_Temporal data structure.

NuoDB_Status(*	getUnmanagedLob )(NuoDB_ResultSet _this, int column, NuoDB_Lob_Type lobType, NuoDB_Lob *lobPtr)
	Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structure as a pointer to a NuoDB_Lob data structure.

nuodb_bool_t(*	isActive )(NuoDB_ResultSet *_this)
	Returns true if the result set is active.

NuoDB_Status(*	next )(NuoDB_ResultSet *_this)
	Moves the cursor froward one row from its current position.

NuoDB_Status(*	setFetchSize )(NuoDB_ResultSet *_this, int fetchSize)
	Setup of the fetch size.

nuodb_bool_t(*	wasNull )(NuoDB_ResultSet *_this)
	Reports whether the last column read had a value of SQL NULL.

Detailed Description

Table of data representing a database result set.

A NuoDB_ResultSet is a table of data representing a database result set, which is usually generated by executing a statement that queries the database.

A NuoDB_ResultSet data structure maintains a cursor pointing to its current row of data. Initially the cursor is positioned before the first row. The next() function moves the cursor to the next row, and because it returns false when there are no more rows in the NuoDB_ResultSet data structure, it can be used in a while loop to iterate through the result set.

The row data for a NuoDB_ResultSet data structure is not updatable and has a cursor that moves forward only. Thus, you can iterate through it only once and only from the first row to the last row.

The NuoDB_ResultSet data structure provides getter functions (getBoolean, getLong, and so on) for retrieving column values from the current row. Values can be retrieved using either the index number of the column or the name of the column. In general, using the column index will be more efficient. Columns are numbered, starting from 1. Result set columns within each row should be read in left-to-right order, and each column should be read only once.

For the getter functions, the NuoDB C driver attempts to convert the underlying SQL data to the C lanuage type specified in the getter function and returns a suitable C language value.

Column names used as input to getter functions are case insensitive. The column name option is designed to be used when column names are used in the SQL query that generated the result set. For columns that are NOT explicitly named in the query, it is best to use column numbers. If column names are used, the programmer should take care to guarantee that they uniquely refer to the intended columns, which can be assured with the SQL AS clause.

A NuoDB_ResultSet data structure is automatically freed when the NuoDB_Statement data structure that generated it is freed or re-executed.

The number, types and properties of a NuoDB_ResultSet data structure's columns are provided by the NuoDB_ResultSetMetaData data structure, which is returned by the NuoDB_ResultSet::getMetaData() function.

Field Documentation

◆ close

NuoDB_Status(* NuoDB_ResultSet::close) (NuoDB_ResultSet *_this)

Close the result set on the server side.

Parameters

[in] _this a pointer to the current (this) data structure.

Returns: Enumerated integer NuoDB_Status. NUODB_SUCCESS (integer 0) on success, or a negative integer on failure.

◆ findColumn

NuoDB_Status(* NuoDB_ResultSet::findColumn) (NuoDB_ResultSet *_this, const char *columnLabel, int *position)

Find the position of a column in a result set.

Parameters

[in]	_this	a pointer to the current (this) data structure.
[in]	columnLabel	the label of the column to find.
[out]	position	the position of the column in the resultSet starting with 1.

Returns: NUODB_SUCCESS if the column was found, error status on failure

◆ getBoolean

NuoDB_Status(* NuoDB_ResultSet::getBoolean) (NuoDB_ResultSet *_this, int column, nuodb_bool_t *boolPtr)

Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structure as a pointer to a nuodb_bool_t type.

Parameters

[in]	_this	a pointer to the current (this) data structure.
[in]	column	the first column is 1, the second is 2, ...
[out]	boolPtr	a pointer to a nuodb_bool_t that contains the column value; if the value is SQL NULL, the nuodb_bool_t pointer is NULL.

Returns: Enumerated integer NuoDB_Status. NUODB_SUCCESS (integer 0) on success, or a negative integer on failure.

◆ getBooleanByLabel

NuoDB_Status(* NuoDB_ResultSet::getBooleanByLabel) (NuoDB_ResultSet *_this, const char *columnLabel, nuodb_bool_t *boolPtr)

Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structure as a pointer to a nuodb_bool_t type.

Parameters

[in]	_this	a pointer to the current (this) data structure.
[in]	columnLabel	the label of the column.
[out]	boolPtr	a pointer to a nuodb_bool_t that contains the column value; if the value is SQL NULL, the nuodb_bool_t pointer is NULL.

Returns: Enumerated integer NuoDB_Status. NUODB_SUCCESS (integer 0) on success, or a negative integer on failure.

◆ getByte

NuoDB_Status(* NuoDB_ResultSet::getByte) (NuoDB_ResultSet *_this, int column, char *charPtr)

Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structure as a pointer to a char.

Parameters

[in]	_this	a pointer to the current (this) data structure.
[in]	column	the first column is 1, the second is 2, ...
[out]	charPtr	a pointer to a char that contains the column value; if the value is SQL NULL, the char is set to zero. Client's can use the function wasNull() to determine if the zero value represents a SQL NULL.

Returns: Enumerated integer NuoDB_Status. NUODB_SUCCESS (integer 0) on success, or a negative integer on failure.

◆ getByteByLabel

NuoDB_Status(* NuoDB_ResultSet::getByteByLabel) (NuoDB_ResultSet *_this, const char *columnLabel, char *charPtr)

Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structure as a pointer to a char.

Parameters

[in]	_this	a pointer to the current (this) data structure.
[in]	columnLabel	the label of the column.
[out]	charPtr	a pointer to a char that contains the column value; if the value is SQL NULL, the char is set to zero. Client's can use the function wasNull() to determine if the zero value represents a SQL NULL.

Returns: Enumerated integer NuoDB_Status. NUODB_SUCCESS (integer 0) on success, or a negative integer on failure.

◆ getBytes

NuoDB_Status(* NuoDB_ResultSet::getBytes) (NuoDB_ResultSet *_this, int column, size_t *length, const char **bytes)

Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structure as a pointer to a binary string.

The string returned is valid only as long as the current row is active in the NuoDB_ResultSet.

Parameters

[in]	_this	a pointer to the current (this) data structure.
[in]	column	the first column is 1, the second is 2, ...
[out]	length	pointer to size_t that holds the number of bytes retrieved
[out]	bytes	a pointer to the retrieved value; if the value is SQL NULL, then *bytes is set to NULL.

Returns: Enumerated integer NuoDB_Status. NUODB_SUCCESS (integer 0) on success, or a negative integer on failure.

◆ getBytesByLabel

NuoDB_Status(* NuoDB_ResultSet::getBytesByLabel) (NuoDB_ResultSet *_this, const char *columnLabel, size_t *length, const char **bytes)

Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structure as a pointer to a string.

The string returned is valid only as long as the current row is active in the NuoDB_ResultSet.

Parameters

[in]	_this	a pointer to the current (this) data structure.
[in]	columnLabel	the label of the column.
[out]	length	pointer to size_t that holds the number of bytes retrieved
[out]	bytes	a pointer to the retrieved value; if the value is SQL NULL, the *bytes is set to NULL. The wasNull() function should be used to determine if the value represents a SQL NULL.

Returns: Enumerated integer NuoDB_Status. NUODB_SUCCESS (integer 0) on success, or a negative integer on failure.

◆ getDouble

NuoDB_Status(* NuoDB_ResultSet::getDouble) (NuoDB_ResultSet *_this, int column, double *doublePtr)

Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structure as a pointer to a double.

Parameters

[in]	_this	a pointer to the current (this) data structure.
[in]	column	the first column is 1, the second is 2, ...
[out]	doublePtr	a pointer to a double that contains the column value; if the value is SQL NULL, the double is set to zero. Client's can use the function wasNull() to determine if the zero value represents a SQL NULL.

Returns: Enumerated integer NuoDB_Status. NUODB_SUCCESS (integer 0) on success, or a negative integer on failure.

◆ getDoubleByLabel

NuoDB_Status(* NuoDB_ResultSet::getDoubleByLabel) (NuoDB_ResultSet *_this, const char *columnLabel, double *doublePtr)

Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structure as a pointer to a double.

Parameters

[in]	_this	a pointer to the current (this) data structure.
[in]	columnLabel	the label of the column.
[out]	doublePtr	a pointer to a double that contains the column value; if the value is SQL NULL, the double is set to zero. Client's can use the function wasNull() to determine if the zero value represents a SQL NULL.

Returns: Enumerated integer NuoDB_Status. NUODB_SUCCESS (integer 0) on success, or a negative integer on failure.

◆ getInt

NuoDB_Status(* NuoDB_ResultSet::getInt) (NuoDB_ResultSet *_this, int column, int32_t *intPtr)

Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structure as a pointer to a int32_t.

Parameters

[in]	_this	a pointer to the current (this) data structure.
[in]	column	the first column is 1, the second is 2, ...
[out]	intPtr	a pointer to a int32_t that contains the column value; if the value is SQL NULL, the int32_t is set to zero. Client's can use the function wasNull() to determine if the zero value represents a SQL NULL.

Returns: Enumerated integer NuoDB_Status. NUODB_SUCCESS (integer 0) on success, or a negative integer on failure.

◆ getIntByLabel

NuoDB_Status(* NuoDB_ResultSet::getIntByLabel) (NuoDB_ResultSet *_this, const char *columnLabel, int32_t *intPtr)

Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structure as a pointer to a int32_t.

Parameters

[in]	_this	a pointer to the current (this) data structure.
[in]	columnLabel	the label of the column.
[out]	intPtr	a pointer to a int32_t that contains the column value; if the value is SQL NULL, the int32_t is set to zero. Client's can use the function wasNull() to determine if the zero value represents a SQL NULL.

Returns: Enumerated integer NuoDB_Status. NUODB_SUCCESS (integer 0) on success, or a negative integer on failure.

◆ getLob

NuoDB_Status(* NuoDB_ResultSet::getLob) (NuoDB_ResultSet *_this, int column, NuoDB_Lob_Type lobType, NuoDB_Lob **lobPtr)

Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structure as a pointer to a NuoDB_Lob data structure.

The NuoDB_Lob returned is valid only as long as the current row is active in the NuoDB_ResultSet.

Parameters

[in]	_this	a pointer to the current (this) data structure.
[in]	column	the first column is 1, the second is 2, ...
[in]	lobType	the NuoDB_Lob_Type.
[out]	lobPtr	a pointer to a NuoDB_Lob pointer that contains the column value; if the value is SQL NULL, the NuoDB_Lob pointer is NULL.

Returns: Enumerated integer NuoDB_Status. NUODB_SUCCESS (integer 0) on success, or a negative integer on failure.

◆ getLobByLabel

NuoDB_Status(* NuoDB_ResultSet::getLobByLabel) (NuoDB_ResultSet *_this, const char *columnLabel, NuoDB_Lob_Type lobType, NuoDB_Lob **lobPtr)

Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structure as a pointer to a NuoDB_Lob data structure.

The NuoDB_Lob returned is valid only as long as the current row is active in the NuoDB_ResultSet.

Parameters

[in]	_this	a pointer to the current (this) data structure.
[in]	columnLabel	the label of the column.
[in]	lobType	the NuoDB_Lob_Type.
[out]	lobPtr	a pointer to a NuoDB_Lob pointer that contains the column value; if the value is SQL NULL, the NuoDB_Lob pointer is NULL.

Returns: Enumerated integer NuoDB_Status. NUODB_SUCCESS (integer 0) on success, or a negative integer on failure.

◆ getLong

NuoDB_Status(* NuoDB_ResultSet::getLong) (NuoDB_ResultSet *_this, int column, int64_t *longPtr)

Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structure as a pointer to a long.

Parameters

[in]	_this	a pointer to the current (this) data structure.
[in]	column	the first column is 1, the second is 2, ...
[out]	longPtr	a pointer to a int64_t that contains the column value; if the value is SQL NULL, the int64_t is set to zero. Client's can use the function wasNull() to determine if the zero value represents a SQL NULL.

Returns: Enumerated integer NuoDB_Status. NUODB_SUCCESS (integer 0) on success, or a negative integer on failure.

◆ getLongByLabel

NuoDB_Status(* NuoDB_ResultSet::getLongByLabel) (NuoDB_ResultSet *_this, const char *columnLabel, int64_t *longPtr)

Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structure as a pointer to a long.

Parameters

[in]	_this	a pointer to the current (this) data structure.
[in]	columnLabel	the label of the column.
[out]	longPtr	a pointer to a int64_t that contains the column value; if the value is SQL NULL, the int64_t is set to zero. Client's can use the function wasNull() to determine if the zero value represents a SQL NULL.

Returns: Enumerated integer NuoDB_Status. NUODB_SUCCESS (integer 0) on success, or a negative integer on failure.

◆ getMetaData

NuoDB_ResultSetMetaData *(* NuoDB_ResultSet::getMetaData) (NuoDB_ResultSet *_this)

Retrieves the number, types and properties of specified NuoDB_ResultSet's columns.

Parameters

[in] _this a pointer to the current (this) data structure.

Returns: a pointer to a NuoDB_ResultSetMetaData data structure, or NULL to indicate an error.

◆ getNumberColumns

int(* NuoDB_ResultSet::getNumberColumns) (NuoDB_ResultSet *_this)

Returns the number of columns.

Parameters

[in] _this a pointer to the current (this) data structure.

Returns: the number of columns in the specified result set.

◆ getShort

NuoDB_Status(* NuoDB_ResultSet::getShort) (NuoDB_ResultSet *_this, int column, short *shortPtr)

Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structure as a pointer to a short.

Parameters

[in]	_this	a pointer to the current (this) data structure.
[in]	column	the first column is 1, the second is 2, ...
[out]	shortPtr	a pointer to a const char * that contains the column value; if the value is SQL NULL, the const char * is NULL.

Returns: Enumerated integer NuoDB_Status. NUODB_SUCCESS (integer 0) on success, or a negative integer on failure.

◆ getShortByLabel

NuoDB_Status(* NuoDB_ResultSet::getShortByLabel) (NuoDB_ResultSet *_this, const char *columnLabel, short *shortPtr)

Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structure as a pointer to a short.

Parameters

[in]	_this	a pointer to the current (this) data structure.
[in]	columnLabel	the label of the column.
[out]	shortPtr	a pointer to the retrieved value. The wasNull() function should be used to determine if the value represents a SQL NULL.

Returns: Enumerated integer NuoDB_Status. NUODB_SUCCESS (integer 0) on success, or a negative integer on failure.

◆ getString

NuoDB_Status(* NuoDB_ResultSet::getString) (NuoDB_ResultSet *_this, int column, const char **strPtr)

Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structure as a pointer to a string data structure.

The string returned is valid only as long as the current row is active in the NuoDB_ResultSet. getString() can only be used with nul terminated strings that do not contain any embedded nul characters. If your application allows strings to have embedded nul characters, or if your strings are not nul terminated, then your client should call getStringWithLength() to retrieve the string buffer and length.

Parameters

[in]	_this	a pointer to the current (this) data structure.
[in]	column	the first column is 1, the second is 2, ...
[out]	strPtr	a pointer to a const char * that contains the column value; if the value is SQL NULL, the const char * is NULL.

Returns: Enumerated integer NuoDB_Status. NUODB_SUCCESS (integer 0) on success, or a negative integer on failure.

◆ getStringByLabel

NuoDB_Status(* NuoDB_ResultSet::getStringByLabel) (NuoDB_ResultSet *_this, const char *columnLabel, const char **strPtr)

Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structure as a pointer to a string data structure.

The string returned is valid only as long as the current row is active in the NuoDB_ResultSet. getStringByLabel() can only be used with nul terminated strings that do not contain any embedded nul characters. If your application allows strings to have embedded nul characters, or if your strings are not nul terminated, then your client should call getStringWithLengthByLabel() to retrieve the string buffer and length.

Parameters

[in]	_this	a pointer to the current (this) data structure.
[in]	columnLabel	the label of the column.
[out]	strPtr	a pointer to a const char * that contains the column value; if the value is SQL NULL, the const char * is NULL.

Returns: Enumerated integer NuoDB_Status. NUODB_SUCCESS (integer 0) on success, or a negative integer on failure.

◆ getStringWithLength

NuoDB_Status(* NuoDB_ResultSet::getStringWithLength) (NuoDB_ResultSet *_this, int column, size_t *length, const char **strPtr)

Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structure as a pointer to a string data structure.

The string returned is valid only as long as the current row is active in the NuoDB_ResultSet.

Parameters

[in]	_this	a pointer to the current (this) data structure.
[in]	column	the first column is 1, the second is 2, ...
[out]	length	pointer to size_t that holds the length of the string in bytes.
[out]	strPtr	a pointer to a const char * that contains the column value; if the value is SQL NULL, the const char * is NULL.

Returns: Enumerated integer NuoDB_Status. NUODB_SUCCESS (integer 0) on success, or a negative integer on failure.

◆ getStringWithLengthByLabel

NuoDB_Status(* NuoDB_ResultSet::getStringWithLengthByLabel) (NuoDB_ResultSet *_this, const char *columnLabel, size_t *length, const char **strPtr)

Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structure as a pointer to a string data structure.

The string returned is valid only as long as the current row is active in the NuoDB_ResultSet.

Parameters

[in]	_this	a pointer to the current (this) data structure.
[in]	columnLabel	the label of the column.
[out]	length	pointer to size_t that holds the length of the string in bytes.
[out]	strPtr	a pointer to a const char * that contains the column value; if the value is SQL NULL, the const char * is NULL.

Returns: Enumerated integer NuoDB_Status. NUODB_SUCCESS (integer 0) on success, or a negative integer on failure.

◆ getTemporal

NuoDB_Status(* NuoDB_ResultSet::getTemporal) (NuoDB_ResultSet *_this, int column, NuoDB_Temporal_Type temporalType, NuoDB_Temporal **temporalPtr)

Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structure as a pointer to a NuoDB_Temporal data structure.

The caller is expected to free returned NuoDB_Temporal using the NuoDB_Temporal_free() function once finished with it.

Parameters

[in]	_this	a pointer to the current (this) data structure.
[in]	column	the first column is 1, the second is 2, ...
[in]	temporalType	the NuoDB_Lob_Type.
[out]	temporalPtr	a pointer to a NuoDB_Temporal pointer that contains the column value; if the value is SQL NULL, the NuoDB_Temporal pointer is NULL.

Returns: Enumerated integer NuoDB_Status. NUODB_SUCCESS (integer 0) on success, or a negative integer on failure.

◆ getTemporalByLabel

NuoDB_Status(* NuoDB_ResultSet::getTemporalByLabel) (NuoDB_ResultSet *_this, const char *columnLabel, NuoDB_Temporal_Type temporalType, NuoDB_Temporal **temporalPtr)

Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structure as a pointer to a NuoDB_Temporal data structure.

The caller is expected to free returned NuoDB_Temporal using the NuoDB_Temporal_free() function once finished with it.

Parameters

[in]	_this	a pointer to the current (this) data structure.
[in]	columnLabel	the label of the column.
[in]	temporalType	the NuoDB_Lob_Type.
[out]	temporalPtr	a pointer to a NuoDB_Temporal pointer that contains the column value; if the value is SQL NULL, the NuoDB_Temporal pointer is NULL.

Returns: Enumerated integer NuoDB_Status. NUODB_SUCCESS (integer 0) on success, or a negative integer on failure.

◆ getUnmanagedLob

NuoDB_Status(* NuoDB_ResultSet::getUnmanagedLob) (NuoDB_ResultSet *_this, int column, NuoDB_Lob_Type lobType, NuoDB_Lob **lobPtr)

Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structure as a pointer to a NuoDB_Lob data structure.

The NuoDB_Lob returned is owned by the caller, who must call NuoDB_Lob_free on it.

Parameters

[in]	_this	a pointer to the current (this) data structure.
[in]	column	the first column is 1, the second is 2, ...
[in]	lobType	the NuoDB_Lob_Type.
[out]	lobPtr	a pointer to a NuoDB_Lob pointer that contains the column value; if the value is SQL NULL, the NuoDB_Lob pointer is NULL.

Returns: Enumerated integer NuoDB_Status. NUODB_SUCCESS (integer 0) on success, or a negative integer on failure.

◆ isActive

nuodb_bool_t(* NuoDB_ResultSet::isActive) (NuoDB_ResultSet *_this)

Returns true if the result set is active.

Parameters

[in] _this a pointer to the current (this) data structure.

Returns: nuodb_bool_t is true if the result set is active. Otherwise returns false.

◆ next

NuoDB_Status(* NuoDB_ResultSet::next) (NuoDB_ResultSet *_this)

Moves the cursor froward one row from its current position.

A NuoDB_ResultSet cursor is initially positioned before the first row; the first call to the function next() makes the first row the current row; the second call makes the second row the current row, and so on.

When a call to the next() function returns NUODB_NO_DATA, the cursor is positioned after the last row. Any invocation of a NuoDB_ResultSet function which requires a current row will result an error state being returned.

Parameters

[in] _this a pointer to the current (this) data structure.

Returns: Returns NuoDB_Status NUODB_SUCCESS on success. Returns NUODB_NO_DATA when called after last row. Returns a negative NuoDB_Status error code for an error condition.

◆ setFetchSize

NuoDB_Status(* NuoDB_ResultSet::setFetchSize) (NuoDB_ResultSet *_this, int fetchSize)

Setup of the fetch size.

Parameters

[in]	_this	a pointer to the current (this) data structure.
[in]	fetchSize	the value of fetch size

Returns: Enumerated integer NuoDB_Status. NUODB_SUCCESS (integer 0) on success, or a negative integer on failure.

◆ wasNull

nuodb_bool_t(* NuoDB_ResultSet::wasNull) (NuoDB_ResultSet *_this)

Reports whether the last column read had a value of SQL NULL.

Note that you must first call one of the getter functions on a column to try to read its value and then call the function wasNull() to see if the value read was SQL NULL.

This function is used to differentiate a zero value from NULL. So getInt() can return 0 but it is really SQL NULL.

Parameters

[in] _this a pointer to the current (this) data structure.

Returns: true if the last column value read was SQL NULL and false otherwise.

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

/data/builds/RELEASE-DB17-LIN/CDriver/nuodb/resultSet.h

Data Fields

Detailed Description

Field Documentation

◆ close

◆ findColumn

◆ getBoolean

◆ getBooleanByLabel

◆ getByte

◆ getByteByLabel

◆ getBytes

◆ getBytesByLabel

◆ getDouble

◆ getDoubleByLabel

◆ getInt

◆ getIntByLabel

◆ getLob

◆ getLobByLabel

◆ getLong

◆ getLongByLabel

◆ getMetaData

◆ getNumberColumns

◆ getShort

◆ getShortByLabel

◆ getString

◆ getStringByLabel

◆ getStringWithLength

◆ getStringWithLengthByLabel

◆ getTemporal

◆ getTemporalByLabel

◆ getUnmanagedLob

◆ isActive

◆ next

◆ setFetchSize

◆ wasNull