odbc::ResultSetMetaData Class Reference

List of all members.

---

Detailed Description

Provides meta data about a result set.

Definition at line 35 of file resultsetmetadata.h.

Public Types
enum	{ columnNoNulls = SQL_NO_NULLS, columnNullable = SQL_NULLABLE, columnNullableUnknown = SQL_NULLABLE_UNKNOWN }
	Nullability constants. More...
enum	{ columnNoNulls = SQL_NO_NULLS, columnNullable = SQL_NULLABLE, columnNullableUnknown = SQL_NULLABLE_UNKNOWN }
	Nullability constants. More...
Public Member Functions
ODBCXX_STRING	getCatalogName (int column)
	Get the catalog name for a column.
ODBCXX_STRING	getCatalogName (int column)
	Get the catalog name for a column.
int	getColumnCount () const
	Fetch the number of columns in this result set.
int	getColumnCount () const
	Fetch the number of columns in this result set.
int	getColumnDisplaySize (int column)
	Get the display size of a column.
int	getColumnDisplaySize (int column)
	Get the display size of a column.
ODBCXX_STRING	getColumnLabel (int column)
	Get the label (if any) for a column.
ODBCXX_STRING	getColumnLabel (int column)
	Get the label (if any) for a column.
const ODBCXX_STRING &	getColumnName (int column) const
	Get the name of a column.
const ODBCXX_STRING &	getColumnName (int column) const
	Get the name of a column.
int	getColumnType (int column) const
	Get the SQL type of a column.
int	getColumnType (int column) const
	Get the SQL type of a column.
ODBCXX_STRING	getColumnTypeName (int column)
	Get the name of a columns SQL type.
ODBCXX_STRING	getColumnTypeName (int column)
	Get the name of a columns SQL type.
int	getPrecision (int column) const
	Get the precision of a column.
int	getPrecision (int column) const
	Get the precision of a column.
int	getScale (int column) const
	Get the scale of a column.
int	getScale (int column) const
	Get the scale of a column.
ODBCXX_STRING	getSchemaName (int column)
	Get the schema name for a column.
ODBCXX_STRING	getSchemaName (int column)
	Get the schema name for a column.
ODBCXX_STRING	getTableName (int column)
	Get the table name for a column.
ODBCXX_STRING	getTableName (int column)
	Get the table name for a column.
bool	isAutoIncrement (int column)
	Check if a column is autoincrementing.
bool	isAutoIncrement (int column)
	Check if a column is autoincrementing.
bool	isCaseSensitive (int column)
	Check if a column is case sensitive.
bool	isCaseSensitive (int column)
	Check if a column is case sensitive.
bool	isCurrency (int column)
	Check if a column can be a currency (eg fixed precision).
bool	isCurrency (int column)
	Check if a column can be a currency (eg fixed precision).
bool	isDefinitelyWritable (int column)
	Check if a column can be updated.
bool	isDefinitelyWritable (int column)
	Check if a column can be updated.
int	isNullable (int column)
	Check if a column can be set to NULL.
int	isNullable (int column)
	Check if a column can be set to NULL.
bool	isReadOnly (int column)
	Check if a column is read only.
bool	isReadOnly (int column)
	Check if a column is read only.
bool	isSearchable (int column)
	Check if a column can be used in a where-clause.
bool	isSearchable (int column)
	Check if a column can be used in a where-clause.
bool	isSigned (int column)
	Check if a column is signed.
bool	isSigned (int column)
	Check if a column is signed.
bool	isWritable (int column)
	Check if a column is 'probably' writeable.
bool	isWritable (int column)
	Check if a column is 'probably' writeable.

---

Member Enumeration Documentation

anonymous enum

Nullability constants.

Enumerator:

columnNoNulls
columnNullable
columnNullableUnknown

Definition at line 71 of file resultsetmetadata.h.

anonymous enum

Nullability constants.

Enumerator:

columnNoNulls
columnNullable
columnNullableUnknown

Definition at line 71 of file resultsetmetadata.h.

---

Member Function Documentation

ODBCXX_STRING odbc::ResultSetMetaData::getCatalogName

(

int

column

)

Get the catalog name for a column.

Parameters:

column

The column index, starting at 1

ODBCXX_STRING odbc::ResultSetMetaData::getCatalogName

(

int

column

)

Get the catalog name for a column.

Parameters:

column

The column index, starting at 1

int odbc::ResultSetMetaData::getColumnDisplaySize

(

int

column

)

Get the display size of a column.

Parameters:

column

The column index, starting at 1

int odbc::ResultSetMetaData::getColumnDisplaySize

(

int

column

)

Get the display size of a column.

Parameters:

column

The column index, starting at 1

ODBCXX_STRING odbc::ResultSetMetaData::getColumnLabel

(

int

column

)

Get the label (if any) for a column.

Parameters:

column

The column index, starting at 1

ODBCXX_STRING odbc::ResultSetMetaData::getColumnLabel

(

int

column

)

Get the label (if any) for a column.

Parameters:

column

The column index, starting at 1

const ODBCXX_STRING& odbc::ResultSetMetaData::getColumnName

(

int

column

)

const

Get the name of a column.

Parameters:

column

The column index, starting at 1

const ODBCXX_STRING& odbc::ResultSetMetaData::getColumnName

(

int

column

)

const

Get the name of a column.

Parameters:

column

The column index, starting at 1

int odbc::ResultSetMetaData::getColumnType

(

int

column

)

const

Get the SQL type of a column.

Parameters:

column

The column index, starting at 1

See also:

Types

int odbc::ResultSetMetaData::getColumnType

(

int

column

)

const

Get the SQL type of a column.

Parameters:

column

The column index, starting at 1

See also:

Types

ODBCXX_STRING odbc::ResultSetMetaData::getColumnTypeName

(

int

column

)

Get the name of a columns SQL type.

Parameters:

column

The column index, starting at 1

ODBCXX_STRING odbc::ResultSetMetaData::getColumnTypeName

(

int

column

)

Get the name of a columns SQL type.

Parameters:

column

The column index, starting at 1

int odbc::ResultSetMetaData::getPrecision

(

int

column

)

const

Get the precision of a column.

Parameters:

column

The column index, starting at 1

int odbc::ResultSetMetaData::getPrecision

(

int

column

)

const

Get the precision of a column.

Parameters:

column

The column index, starting at 1

int odbc::ResultSetMetaData::getScale

(

int

column

)

const

Get the scale of a column.

Parameters:

column

The column index, starting at 1

int odbc::ResultSetMetaData::getScale

(

int

column

)

const

Get the scale of a column.

Parameters:

column

The column index, starting at 1

ODBCXX_STRING odbc::ResultSetMetaData::getSchemaName

(

int

column

)

Get the schema name for a column.

Parameters:

column

The column index, starting at 1

ODBCXX_STRING odbc::ResultSetMetaData::getSchemaName

(

int

column

)

Get the schema name for a column.

Parameters:

column

The column index, starting at 1

ODBCXX_STRING odbc::ResultSetMetaData::getTableName

(

int

column

)

Get the table name for a column.

Parameters:

column

The column index, starting at 1

ODBCXX_STRING odbc::ResultSetMetaData::getTableName

(

int

column

)

Get the table name for a column.

Parameters:

column

The column index, starting at 1

bool odbc::ResultSetMetaData::isAutoIncrement

(

int

column

)

Check if a column is autoincrementing.

Parameters:

column

The column index, starting at 1

bool odbc::ResultSetMetaData::isAutoIncrement

(

int

column

)

Check if a column is autoincrementing.

Parameters:

column

The column index, starting at 1

bool odbc::ResultSetMetaData::isCaseSensitive

(

int

column

)

Check if a column is case sensitive.

Parameters:

column

The column index, starting at 1

bool odbc::ResultSetMetaData::isCaseSensitive

(

int

column

)

Check if a column is case sensitive.

Parameters:

column

The column index, starting at 1

bool odbc::ResultSetMetaData::isCurrency

(

int

column

)

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

Parameters:

column

The column index, starting at 1

bool odbc::ResultSetMetaData::isCurrency

(

int

column

)

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

Parameters:

column

The column index, starting at 1

bool odbc::ResultSetMetaData::isDefinitelyWritable

(

int

column

)

Check if a column can be updated.

Parameters:

column

The column index, starting at 1

bool odbc::ResultSetMetaData::isDefinitelyWritable

(

int

column

)

Check if a column can be updated.

Parameters:

column

The column index, starting at 1

int odbc::ResultSetMetaData::isNullable

(

int

column

)

Check if a column can be set to NULL.

Parameters:

column

The column index, starting at 1

int odbc::ResultSetMetaData::isNullable

(

int

column

)

Check if a column can be set to NULL.

Parameters:

column

The column index, starting at 1

bool odbc::ResultSetMetaData::isReadOnly

(

int

column

)

Check if a column is read only.

Parameters:

column

The column index, starting at 1

bool odbc::ResultSetMetaData::isReadOnly

(

int

column

)

Check if a column is read only.

Parameters:

column

The column index, starting at 1

bool odbc::ResultSetMetaData::isSearchable

(

int

column

)

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

Parameters:

column

The column index, starting at 1

bool odbc::ResultSetMetaData::isSearchable

(

int

column

)

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

Parameters:

column

The column index, starting at 1

bool odbc::ResultSetMetaData::isSigned

(

int

column

)

Check if a column is signed.

Parameters:

column

The column index, starting at 1

bool odbc::ResultSetMetaData::isSigned

(

int

column

)

Check if a column is signed.

Parameters:

column

The column index, starting at 1

bool odbc::ResultSetMetaData::isWritable

(

int

column

)

Check if a column is 'probably' writeable.

Parameters:

column

The column index, starting at 1

bool odbc::ResultSetMetaData::isWritable

(

int

column

)

Check if a column is 'probably' writeable.

Parameters:

column

The column index, starting at 1

---

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

• core/odbc++/resultsetmetadata.h
• tape_ODBC/odbc++/resultsetmetadata.h

---

GridLAB-D^TM Version 1.0

An open-source project initiated by the US Department of Energy