libodbc++  0.2.5
Public Types | Public Member Functions | List of all members
odbc::ResultSetMetaData Class Reference

Provides meta data about a result set. More...

#include <resultsetmetadata.h>

Public Types

enum  
 Nullability constants.
 

Public Member Functions

int getColumnCount () const
 Fetch the number of columns in this result set.
 
const std::string & getColumnName (int column) const
 Get the name of a column. More...
 
int getColumnType (int column) const
 Get the SQL type of a column. More...
 
int getPrecision (int column) const
 Get the precision of a column. More...
 
int getScale (int column) const
 Get the scale of a column. More...
 
int getColumnDisplaySize (int column)
 Get the display size of a column. More...
 
std::string getCatalogName (int column)
 Get the catalog name for a column. More...
 
std::string getColumnLabel (int column)
 Get the label (if any) for a column. More...
 
std::string getColumnTypeName (int column)
 Get the name of a columns SQL type. More...
 
std::string getSchemaName (int column)
 Get the schema name for a column. More...
 
std::string getTableName (int column)
 Get the table name for a column. More...
 
bool isAutoIncrement (int column)
 Check if a column is autoincrementing. More...
 
bool isCaseSensitive (int column)
 Check if a column is case sensitive. More...
 
bool isCurrency (int column)
 Check if a column can be a currency (eg fixed precision) More...
 
bool isDefinitelyWritable (int column)
 Check if a column can be updated. More...
 
int isNullable (int column)
 Check if a column can be set to NULL. More...
 
bool isReadOnly (int column)
 Check if a column is read only. More...
 
bool isSearchable (int column)
 Check if a column can be used in a where-clause. More...
 
bool isSigned (int column)
 Check if a column is signed. More...
 
bool isWritable (int column)
 Check if a column is 'probably' writeable. More...
 

Detailed Description

Provides meta data about a result set.

Member Function Documentation

std::string odbc::ResultSetMetaData::getCatalogName ( int  column)

Get the catalog name for a column.

Parameters
columnThe column index, starting at 1
int odbc::ResultSetMetaData::getColumnDisplaySize ( int  column)

Get the display size of a column.

Parameters
columnThe column index, starting at 1
std::string odbc::ResultSetMetaData::getColumnLabel ( int  column)

Get the label (if any) for a column.

Parameters
columnThe column index, starting at 1
const std::string& odbc::ResultSetMetaData::getColumnName ( int  column) const

Get the name of a column.

Parameters
columnThe column index, starting at 1
int odbc::ResultSetMetaData::getColumnType ( int  column) const

Get the SQL type of a column.

Parameters
columnThe column index, starting at 1
See also
Types
std::string odbc::ResultSetMetaData::getColumnTypeName ( int  column)

Get the name of a columns SQL type.

Parameters
columnThe column index, starting at 1
int odbc::ResultSetMetaData::getPrecision ( int  column) const

Get the precision of a column.

Parameters
columnThe column index, starting at 1
int odbc::ResultSetMetaData::getScale ( int  column) const

Get the scale of a column.

Parameters
columnThe column index, starting at 1
std::string odbc::ResultSetMetaData::getSchemaName ( int  column)

Get the schema name for a column.

Parameters
columnThe column index, starting at 1
std::string odbc::ResultSetMetaData::getTableName ( int  column)

Get the table name for a column.

Parameters
columnThe column index, starting at 1
bool odbc::ResultSetMetaData::isAutoIncrement ( int  column)

Check if a column is autoincrementing.

Parameters
columnThe column index, starting at 1
bool odbc::ResultSetMetaData::isCaseSensitive ( int  column)

Check if a column is case sensitive.

Parameters
columnThe column index, starting at 1
bool odbc::ResultSetMetaData::isCurrency ( int  column)

Check if a column can be a currency (eg fixed precision)

Parameters
columnThe column index, starting at 1
bool odbc::ResultSetMetaData::isDefinitelyWritable ( int  column)

Check if a column can be updated.

Parameters
columnThe column index, starting at 1
int odbc::ResultSetMetaData::isNullable ( int  column)

Check if a column can be set to NULL.

Parameters
columnThe column index, starting at 1
bool odbc::ResultSetMetaData::isReadOnly ( int  column)

Check if a column is read only.

Parameters
columnThe column index, starting at 1
bool odbc::ResultSetMetaData::isSearchable ( int  column)

Check if a column can be used in a where-clause.

Parameters
columnThe column index, starting at 1
bool odbc::ResultSetMetaData::isSigned ( int  column)

Check if a column is signed.

Parameters
columnThe column index, starting at 1
bool odbc::ResultSetMetaData::isWritable ( int  column)

Check if a column is 'probably' writeable.

Parameters
columnThe column index, starting at 1

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

Go back to the libodbc++ homepage