Main Page   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members  

odbc::ResultSet Class Reference

A result set. More...

#include <resultset.h>

Inheritance diagram for odbc::ResultSet::

odbc::ErrorHandler List of all members.

Public Types

Public Methods

Detailed Description

A result set.

Member Enumeration Documentation

anonymous enum
 

ResultSet concurrency constants.

Enumeration values:
CONCUR_READ_ONLY  The ResultSet is read only.
CONCUR_UPDATABLE  The ResultSet is updatable.

anonymous enum
 

ResultSet type constants.

Enumeration values:
TYPE_FORWARD_ONLY  The result set only goes forward.
TYPE_SCROLL_INSENSITIVE  The result set is scrollable, but the data in it is not affected by changes in the database.
TYPE_SCROLL_SENSITIVE  The result set is scrollable and sensitive to database changes.

Member Function Documentation

bool odbc::ResultSet::absolute (  int    row ) 
 

Moves the cursor to a specific row in this result set.

If row is negative, the actual row number is calculated from the end of the result set. Calling absolute(0) is equivalent to calling beforeFirst()

Returns:
true if the cursor is in the result set

bool odbc::ResultSet::first (    ) 
 

Moves to the first row in the result set.

Returns:
true if the cursor is in the result set

std::istream* odbc::ResultSet::getAsciiStream (  const std::string &    colName ) 
 

Fetches a column's value as a stream.

Note that the stream is owned by the result set and should in no case be deleted by the caller. Also, the returned stream is only valid while the cursor remains on this position.

Parameters:
colName  The column name

std::istream* odbc::ResultSet::getAsciiStream (  int    idx ) 
 

Fetches a column's value as a stream.

Note that the stream is owned by the result set and should in no case be deleted by the caller. Also, the returned stream is only valid while the cursor remains on this position.

Parameters:
idx  The column index, starting at 1

std::istream* odbc::ResultSet::getBinaryStream (  const std::string &    colName ) 
 

Fetches a column's value as a stream.

Note that the stream is owned by the result set and should in no case be deleted by the caller. Also, the returned stream is only valid while the cursor remains on this position.

Parameters:
colName  The column name

std::istream* odbc::ResultSet::getBinaryStream (  int    idx ) 
 

Fetches a column's value as a stream.

Note that the stream is owned by the result set and should in no case be deleted by the caller. Also, the returned stream is only valid while the cursor remains on this position.

Parameters:
idx  The column index, starting at 1

bool odbc::ResultSet::getBoolean (  const std::string &    colName ) 
 

Gets a column's value as a bool.

Parameters:
colName  The name of the column

bool odbc::ResultSet::getBoolean (  int    idx ) 
 

Gets a column's value as a bool.

Parameters:
idx  The column index, starting at 1

signed char odbc::ResultSet::getByte (  const std::string &    colName ) 
 

Gets a column's value as a signed char.

Parameters:
colName  The name of the column

signed char odbc::ResultSet::getByte (  int    idx ) 
 

Gets a column's value as a signed char.

Parameters:
idx  The column index, starting at 1

Bytes odbc::ResultSet::getBytes (  const std::string &    colName ) 
 

Gets a column's value as a chunk of bytes.

Parameters:
colName  The name of the column

Bytes odbc::ResultSet::getBytes (  int    idx ) 
 

Gets a column's value as a chunk of bytes.

Parameters:
idx  The column index, starting at 1

Date odbc::ResultSet::getDate (  const std::string &    colName ) 
 

Gets a column's value as a Date.

Parameters:
colName  The name of the column

Date odbc::ResultSet::getDate (  int    idx ) 
 

Gets a column's value as a Date.

Parameters:
idx  The column index, starting at 1

double odbc::ResultSet::getDouble (  const std::string &    colName ) 
 

Gets a column's value as a double.

Parameters:
colName  The name of the column

double odbc::ResultSet::getDouble (  int    idx ) 
 

Gets a column's value as a double.

Parameters:
idx  The column index, starting at 1

float odbc::ResultSet::getFloat (  const std::string &    colName ) 
 

Gets a column's value as a float.

Parameters:
colName  The name of the column

float odbc::ResultSet::getFloat (  int    idx ) 
 

Gets a column's value as a float.

Parameters:
idx  The column index, starting at 1

int odbc::ResultSet::getInt (  const std::string &    colName ) 
 

Gets a column's value as an int.

Parameters:
colName  The name of the column

int odbc::ResultSet::getInt (  int    idx ) 
 

Gets a column's value as an int.

Parameters:
idx  The column index, starting at 1

Long odbc::ResultSet::getLong (  const std::string &    colName ) 
 

Gets a column's value as a Long.

Parameters:
colName  The name of the column

Long odbc::ResultSet::getLong (  int    idx ) 
 

Gets a column's value as a Long.

Parameters:
idx  The column index, starting at 1

ResultSetMetaData* odbc::ResultSet::getMetaData (    ) 
 

Returns meta data about this result set.

See also:
ResultSetMetaData

int odbc::ResultSet::getRow (    ) 
 

Returns the current row number.

Returns:
The current row number in the result set, or 0 if it can't be determined.

short odbc::ResultSet::getShort (  const std::string &    colName ) 
 

Gets a column's value as a short.

Parameters:
colName  The name of the column

short odbc::ResultSet::getShort (  int    idx ) 
 

Gets a column's value as a short.

Parameters:
idx  The column index, starting at 1

std::string odbc::ResultSet::getString (  const std::string &    colName ) 
 

Gets a column's value as a string.

Parameters:
colName  The name of the column

std::string odbc::ResultSet::getString (  int    idx ) 
 

Gets a column's value as a string.

Parameters:
idx  The column index, starting at 1

Time odbc::ResultSet::getTime (  const std::string &    colName ) 
 

Gets a column's value as a Time.

Parameters:
colName  The name of the column

Time odbc::ResultSet::getTime (  int    idx ) 
 

Gets a column's value as a Time.

Parameters:
idx  The column index, starting at 1

Timestamp odbc::ResultSet::getTimestamp (  const std::string &    colName ) 
 

Gets a column's value as a Timestamp.

Parameters:
colName  The name of the column

Timestamp odbc::ResultSet::getTimestamp (  int    idx ) 
 

Gets a column's value as a Timestamp.

Parameters:
idx  The column index, starting at 1

void odbc::ResultSet::insertRow (    ) 
 

Inserts the current row.

Only valid while on the insert row.

See also:
moveToInsertRow()

bool odbc::ResultSet::last (    ) 
 

Moves to the last row in the result set.

Returns:
true if the cursor is in the result set

void odbc::ResultSet::moveToInsertRow (    ) 
 

Moves the cursor to the 'insert row' of this result set.

Warning:
The only valid methods while on the insert row are updateXXX(), insertRow() and moveToCurrentRow().
See also:
moveToCurrentRow()

bool odbc::ResultSet::next (    ) 
 

Moves to the next row in the result set.

Returns:
true if the cursor is in the result set

bool odbc::ResultSet::previous (    ) 
 

Moves to the previous row in the result set.

Returns:
true if the cursor is in the result set

bool odbc::ResultSet::relative (  int    rows ) 
 

Moves the cursor inside the result set relative to the current row.

Negative values are allowed. This call is illegal if there is no current row.

Returns:
true if the cursor is in the result set

void odbc::ResultSet::updateAsciiStream (  const std::string &    colName,
std::istream *    s,
int    len
) 
 

Sets the value of a column to the contens of a stream.

Parameters:
colName  The column name
s  The stream to assign
len  The number of bytes in the stream

void odbc::ResultSet::updateAsciiStream (  int    idx,
std::istream *    s,
int    len
) 
 

Sets the value of a column to a stream.

Parameters:
idx  The column index, starting at 1
s  The stream to assign
len  The number of bytes in the stream

void odbc::ResultSet::updateBinaryStream (  const std::string &    colName,
std::istream *    s,
int    len
) 
 

Sets the value of a column to the contens of a stream.

Parameters:
colName  The column name
s  The stream to assign
len  The number of bytes in the stream

void odbc::ResultSet::updateBinaryStream (  int    idx,
std::istream *    s,
int    len
) 
 

Sets the value of a column to the contens of a stream.

Parameters:
idx  The column index, starting at 1
s  The stream to assign
len  The number of bytes in the stream

void odbc::ResultSet::updateBoolean (  const std::string &    colName,
bool    val
) 
 

Sets the value of a column to a bool.

Parameters:
colName  The name of the column
val  The value to set

void odbc::ResultSet::updateBoolean (  int    idx,
bool    val
) 
 

Sets the value of a column to a bool.

Parameters:
idx  The column index, starting at 1
val  The value to set

void odbc::ResultSet::updateByte (  const std::string &    colName,
signed char    val
) 
 

Sets the value of a column to a signed char.

Parameters:
colName  The name of the column
val  The value to set

void odbc::ResultSet::updateByte (  int    idx,
signed char    val
) 
 

Sets the value of a column to a signed char.

Parameters:
idx  The column index, starting at 1
val  The value to set

void odbc::ResultSet::updateBytes (  const std::string &    colName,
const Bytes &    val
) 
 

Sets the value of a column to a chunk of bytes.

Parameters:
colName  The name of the column
val  The value to set

void odbc::ResultSet::updateBytes (  int    idx,
const Bytes &    val
) 
 

Sets the value of a column to a chunk of bytes.

Parameters:
idx  The column index, starting at 1
val  The value to set

void odbc::ResultSet::updateDate (  const std::string &    colName,
const Date &    val
) 
 

Sets the value of a column to a Date.

Parameters:
colName  The name of the column
val  The value to set

void odbc::ResultSet::updateDate (  int    idx,
const Date &    val
) 
 

Sets the value of a column to a Date.

Parameters:
idx  The column index, starting at 1
val  The value to set

void odbc::ResultSet::updateDouble (  const std::string &    colName,
double    val
) 
 

Sets the value of a column to a double.

Parameters:
colName  The name of the column
val  The value to set

void odbc::ResultSet::updateDouble (  int    idx,
double    val
) 
 

Sets the value of a column to a double.

Parameters:
idx  The column index, starting at 1
val  The value to set

void odbc::ResultSet::updateFloat (  const std::string &    colName,
float    val
) 
 

Sets the value of a column to a float.

Parameters:
colName  The name of the column
val  The value to set

void odbc::ResultSet::updateFloat (  int    idx,
float    val
) 
 

Sets the value of a column to a float.

Parameters:
idx  The column index, starting at 1
val  The value to set

void odbc::ResultSet::updateInt (  const std::string &    colName,
int    val
) 
 

Sets the value of a column to an int.

Parameters:
colName  The name of the column
val  The value to set

void odbc::ResultSet::updateInt (  int    idx,
int    val
) 
 

Sets the value of a column to an int.

Parameters:
idx  The column index, starting at 1
val  The value to set

void odbc::ResultSet::updateLong (  const std::string &    colName,
Long    val
) 
 

Sets the value of a column to a Long.

Parameters:
colName  The name of the column
val  The value to set

void odbc::ResultSet::updateLong (  int    idx,
Long    val
) 
 

Sets the value of a column to a Long.

Parameters:
idx  The column index, starting at 1
val  The value to set

void odbc::ResultSet::updateNull (  const std::string &    colName ) 
 

Sets the value of a column to NULL.

Parameters:
colName  The column name

void odbc::ResultSet::updateNull (  int    idx ) 
 

Sets the value of a column to NULL.

Parameters:
idx  The column index, starting at 1

void odbc::ResultSet::updateShort (  const std::string &    colName,
short    val
) 
 

Sets the value of a column to a short.

Parameters:
colName  The name of the column
val  The value to set

void odbc::ResultSet::updateShort (  int    idx,
short    val
) 
 

Sets the value of a column to a short.

Parameters:
idx  The column index, starting at 1
val  The value to set

void odbc::ResultSet::updateString (  const std::string &    colName,
const std::string &    val
) 
 

Sets the value of a column to a string.

Parameters:
colName  The name of the column
val  The value to set

void odbc::ResultSet::updateString (  int    idx,
const std::string &    val
) 
 

Sets the value of a column to a string.

Parameters:
idx  The column index, starting at 1
val  The value to set

void odbc::ResultSet::updateTime (  const std::string &    colName,
const Time &    val
) 
 

Sets the value of a column to a Time.

Parameters:
colName  The name of the column
val  The value to set

void odbc::ResultSet::updateTime (  int    idx,
const Time &    val
) 
 

Sets the value of a column to a Time.

Parameters:
idx  The column index, starting at 1
val  The value to set

void odbc::ResultSet::updateTimestamp (  const std::string &    colName,
const Timestamp &    val
) 
 

Sets the value of a column to a Timestamp.

Parameters:
colName  The name of the column
val  The value to set

void odbc::ResultSet::updateTimestamp (  int    idx,
const Timestamp &    val
) 
 

Sets the value of a column to a Timestamp.

Parameters:
idx  The column index, starting at 1
val  The value to set

bool odbc::ResultSet::wasNull (    ) 
 

Checks if the last fetched column value was NULL.

Note that if this is true, the returned value was undefined.

The documentation for this class was generated from the following file:
Go back to the freeodbc++ homepage