A SQLDBC row set is a window on a result set.
The size of the row set is determined by the setRowSetSize() method of the SQLDBC_ResultSet object. The method fetch retrieves the rows from the SQLDBC_RowSet object into the bound columns. The getObject() method retrieves one column from the current row into the given buffer. The setPos() method moves the cursor within the row set.
Definition at line 782 of file SQLDBC.h.
SQLDBC::SQLDBC_RowSet::SQLDBC_RowSet | ( | IFR_ResultSet * | resultset | ) | [protected] |
SQLDBC_Retcode SQLDBC::SQLDBC_RowSet::setPos | ( | SQLDBC_UInt4 | pos | ) |
Sets the cursor to row pos in the SQLDBC_RowSet.
pos | Row number within the row set. The first row of a row set is row number one. |
SQLDBC_Retcode SQLDBC::SQLDBC_RowSet::fetch | ( | ) |
Writes the retrieved data to the bound columns.
const SQLDBC_Int4 SQLDBC::SQLDBC_RowSet::getRowsAffected | ( | ) | const |
Returns the number of rows written to the bound parameters.
const SQLDBC_Int4* SQLDBC::SQLDBC_RowSet::getRowStatus | ( | ) | const |
Returns the row status array for the last fetch call.
The row status array describes the state of each row. The maximum size of the row status array is given by the setRowSetSize(). The row status array is filled during the fetch() call. The return code of the first row matches to the first member of the row status array.
SQLDBC_Retcode SQLDBC::SQLDBC_RowSet::getObject | ( | const SQLDBC_Int4 | Index, | |
const SQLDBC_HostType | Type, | |||
void * | paramAddr, | |||
SQLDBC_Length * | LengthIndicator, | |||
const SQLDBC_Length | Size, | |||
const SQLDBC_Bool | Terminate = SQLDBC_TRUE | |||
) |
Retrieves and converts the value of the specified column of the current row to a buffer.
The specified column value in the current row of this SQLDBC_RowSet object is converted to the given length and SQLDBC_HostType and written to the output parameter buffer pointed to paramAddr.
It can be called multiple times to retrieve character or binary data in parts. For fixed-length datatypes getObject retrieves the same data multiple times. Mixing variable-length datatypes and fixed-length datatypes may produce unexpected results.
The current row may be set by a positioning command from SQLDBC_ResultSet (current row = 1) or by the setPos method of the SQLDBC_RowSet object.
Index | Index of the column. The first column is column number 1, the second is column number 2, ... | |
Type | Parameter type of the output buffer. | |
paramAddr | A pointer to the parameters output buffer. | |
LengthIndicator | [out] Pointer to a variable that stores the column length or the indicator value SQLDBC_NULL_DATA if the column contains the NULL value. For character data it contains on success the number of bytes copied to the buffer, except the number of bytes necessary for the zero-terminator, if the Terminate flag was set. If the source string exceeds the Size value SQLDBC_DATA_TRUNC will be returned and LengthIndicator is set to the number of bytes (except the terminator bytes) needed to copy without truncation. | |
Size | [in] Length of the parameter buffer in bytes. The Size argument is only necessary for non-integral data types. For character data the Size argument must be large enough to store the terminator byte(s) if the Terminate flag is set. | |
Terminate | [in] Specifies that the output buffer must be finished with a C-style zero-terminator. The Terminate flag works only for the host var type character (ASCII, UCS2 or UTF8). As a default, all character data is zero-terminated. |
SQLDBC_Retcode SQLDBC::SQLDBC_RowSet::getObject | ( | const SQLDBC_Int4 | Index, | |
const SQLDBC_HostType | Type, | |||
void * | paramAddr, | |||
SQLDBC_Length * | LengthIndicator, | |||
const SQLDBC_Length | Size, | |||
SQLDBC_Length | StartPos, | |||
const SQLDBC_Bool | Terminate = SQLDBC_TRUE | |||
) |
Retrieves and converts the value with an start offset in of the specified column from a of the current row to a buffer.
The specified column value in the current row of this SQLDBC_RowSet object is converted to the given length and SQLDBC_HostType and written to the output parameter buffer pointed to paramAddr.
It can be called multiple times to retrieve character or binary data in parts. For fixed-length datatypes getObject retrieves the same data multiple times. Mixing variable-length datatypes and fixed-length datatypes may produce unexpected results.
The current row may be set by a positioning command from SQLDBC_ResultSet (current row = 1) or by the setPos method of the SQLDBC_RowSet object.
Index | Index of the column. The first column is column number 1, the second is column number 2, ... | |
Type | Parameter type of the output buffer. | |
paramAddr | A pointer to the parameters output buffer. | |
LengthIndicator | [out] Pointer to a variable that stores the column length or the indicator value SQLDBC_NULL_DATA if the column contains the NULL value. For character data it contains on success the number of bytes copied to the buffer, except the number of bytes necessary for the zero-terminator, if the Terminate flag was set. If the source string exceeds the Size value SQLDBC_DATA_TRUNC will be returned and LengthIndicator is set to the number of bytes (except the terminator bytes) needed to copy without truncation. | |
Size | [in] Length of the parameter buffer in bytes. The Size argument is only necessary for non-integral data types. For character data the Size argument must be large enough to store the terminator byte(s) if the Terminate flag is set. | |
StartPos | [in] Start position in long column from which on the data should be retrieved. Start position is counted in bytes from 1. Negative StartPos counts from the end of the long column. | |
Terminate | [in] Specifies that the output buffer must be finished with a C-style zero-terminator. The Terminate flag works only for the host var type character (ASCII, UCS2 or UTF8). As a default, all character data is zero-terminated. |
SQLDBC_ErrorHndl& SQLDBC::SQLDBC_ConnectionItem::error | ( | ) | [inherited] |
Returns a reference to the ErrorHndl object.
void SQLDBC::SQLDBC_ConnectionItem::clearError | ( | ) | [inherited] |
Deletes the error has been stored.
SQLDBC_SQLWarning* SQLDBC::SQLDBC_ConnectionItem::warning | ( | ) | [inherited] |
Returns a reference to an SQLWarning object stored in the SQLDBC_ConnectionItem object.
void SQLDBC::SQLDBC_ConnectionItem::clearWarnings | ( | ) | [inherited] |
Deletes the warning stored in the SQLWarning object.