C++ Client API 1.4 (November 2023)
 
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
dbSpaces::dbcli::ResultSetColumnMetaData Class Reference

#include <Ccdb_ResultSetColumnMetaData.h>

Inheritance diagram for dbSpaces::dbcli::ResultSetColumnMetaData:
Inheritance graph
[legend]
Collaboration diagram for dbSpaces::dbcli::ResultSetColumnMetaData:
Collaboration graph
[legend]

Public Member Functions

virtual ~ResultSetColumnMetaData ()
 
const dtSTRING * GetCatalogName ()
 
const dtSTRING * GetColumnName ()
 
const dtLARGE GetDisplaySize ()
 
const dtLARGE GetMultiValues ()
 
const dtULARGE GetOrdinalPosition ()
 
const dtLARGE GetPrecision ()
 
const dtSTRING * GetQualifiedName ()
 
const dtSTRING * GetRemark ()
 
const dtLARGE GetScale ()
 
const dtSTRING * GetSchemaName ()
 
const dtLARGE GetSearchable ()
 
const dtLARGE GetSqlTypeID ()
 
const dtSTRING * GetSqlTypeName ()
 
const dtUTINY GetStorageClass ()
 
const dtLARGE GetStorageSize ()
 
const dtSTRING * GetTableName ()
 
const dtLARGE GetUpdatable ()
 
const dtBOOLEAN IsAutoIncrement ()
 
const dtBOOLEAN IsCurrency ()
 
const dtBOOLEAN IsNullable ()
 
const dtBOOLEAN IsSigned ()
 
const dtBOOLEAN IsValidColumn () const
 
- Public Member Functions inherited from dbSpaces::dbcli::cdbBase
 cdbBase (cdbBase *, ccdbClassType, dtBOOLEAN=TRUE)
 
virtual ~cdbBase ()
 
cdb_childList_t & GetChildList ()
 
Ccoms_CommsManager * GetTransportComms ()
 
ccdbClassType GetType ()
 
void SetTransportComms (Ccoms_CommsManager *)
 

Protected Member Functions

 ResultSetColumnMetaData ()
 

Detailed Description

A ResultSetColumnMetaData object can be used to find out about the types and properties of a column in a ResultSet.

Since
Version 1.0

Constructor & Destructor Documentation

◆ ResultSetColumnMetaData()

dbSpaces::dbcli::ResultSetColumnMetaData::ResultSetColumnMetaData ( )
protected

ResultSetColumnMetaData default constructor.

Since
Version 1.0

◆ ~ResultSetColumnMetaData()

virtual dbSpaces::dbcli::ResultSetColumnMetaData::~ResultSetColumnMetaData ( )
virtual

ResultSetColumnMetaData destructor.

Since
Version 1.0

Member Function Documentation

◆ GetCatalogName()

const dtSTRING * dbSpaces::dbcli::ResultSetColumnMetaData::GetCatalogName ( )

Get the catalog name for the ResultSet column.

Returns
The catalog name.
Since
Version 1.0

◆ GetColumnName()

const dtSTRING * dbSpaces::dbcli::ResultSetColumnMetaData::GetColumnName ( )

Get the column name for the ResultSet column.

Returns
The column name.
Since
Version 1.0

◆ GetDisplaySize()

const dtLARGE dbSpaces::dbcli::ResultSetColumnMetaData::GetDisplaySize ( )

Get the display Size for the ResultSet column.

Returns
The display size.
Since
Version 1.0

◆ GetMultiValues()

const dtLARGE dbSpaces::dbcli::ResultSetColumnMetaData::GetMultiValues ( )

Get the number of multi-values (array size) for the column.

Returns
The number of multi-values.
Since
Version 1.0

◆ GetOrdinalPosition()

const dtULARGE dbSpaces::dbcli::ResultSetColumnMetaData::GetOrdinalPosition ( )

Get the column's position in the ResultSet.

Returns
The column ordinal position.
Since
Version 1.0

◆ GetPrecision()

const dtLARGE dbSpaces::dbcli::ResultSetColumnMetaData::GetPrecision ( )

Get the Precision value for the ResultSet column. Precision is the number of digits in a number.

Returns
The column precision.
Since
Version 1.0

◆ GetQualifiedName()

const dtSTRING * dbSpaces::dbcli::ResultSetColumnMetaData::GetQualifiedName ( )

Get the qualified name for the ResultSet column. The qualified name consists of the table name and the column name separated by a full stop.

Returns
The qualified name.
Since
Version 1.0

◆ GetRemark()

const dtSTRING * dbSpaces::dbcli::ResultSetColumnMetaData::GetRemark ( )

Get the remark (description) for the ResultSet column.

Returns
The column remark.
Since
Version 1.0

◆ GetScale()

const dtLARGE dbSpaces::dbcli::ResultSetColumnMetaData::GetScale ( )

Get the Scale value for the ResultSet column. Scale is the number of digits to the right of the decimal point in a number.

Returns
The column scale
Since
Version 1.0

◆ GetSchemaName()

const dtSTRING * dbSpaces::dbcli::ResultSetColumnMetaData::GetSchemaName ( )

Get the schema name for the ResultSet column.

Returns
The schema name.
Since
Version 1.0

◆ GetSearchable()

const dtLARGE dbSpaces::dbcli::ResultSetColumnMetaData::GetSearchable ( )

Get the searchable attribute for the ResultSet column. The following are possible values that can be returned;

  • 0 - SQL_UNSEARCHABLE
  • 1 - SQL_LIKE_ONLY
  • 2 - SQL_ALL_EXCEPT_LIKE
  • 3 - SQL_SEARCHABLE
Returns
The searchable attribute.
Since
Version 1.0

◆ GetSqlTypeID()

const dtLARGE dbSpaces::dbcli::ResultSetColumnMetaData::GetSqlTypeID ( )

Get the SQL data type ID for the ResultSet column.

Returns
The SQL data type ID.
Since
Version 1.0

◆ GetSqlTypeName()

const dtSTRING * dbSpaces::dbcli::ResultSetColumnMetaData::GetSqlTypeName ( )

Get the SQL data type name for the ResultSet column.

Returns
The SQL data type name.
Since
Version 1.0

◆ GetStorageClass()

const dtUTINY dbSpaces::dbcli::ResultSetColumnMetaData::GetStorageClass ( )

Get the System Storage Class for the ResultSet column.

Returns
The storage class.
Since
Version 1.0

◆ GetStorageSize()

const dtLARGE dbSpaces::dbcli::ResultSetColumnMetaData::GetStorageSize ( )

Get the System Storage Size for the ResultSet column.

Returns
The storage size.
Since
Version 1.0

◆ GetTableName()

const dtSTRING * dbSpaces::dbcli::ResultSetColumnMetaData::GetTableName ( )

Get the table name for the ResultSet column.

Returns
The table name.
Since
Version 1.0

◆ GetUpdatable()

const dtLARGE dbSpaces::dbcli::ResultSetColumnMetaData::GetUpdatable ( )

Get the updatable attribute for the ResultSet column. The following are possible values that can be returned:

  • 0 - SQL_ATTR_READONLY
  • 1 - SQL_ATTR_WRITE
  • 2 - SQL_ATTR_READWRITE_UNKNOWN
Returns
The updatable attribute.
Since
Version 1.0

◆ IsAutoIncrement()

const dtBOOLEAN dbSpaces::dbcli::ResultSetColumnMetaData::IsAutoIncrement ( )

Checks if the ResultSet column is is automatically numbered.

Returns
TRUE for auto increment type; FALSE if otherwise.
Since
Version 1.0

◆ IsCurrency()

const dtBOOLEAN dbSpaces::dbcli::ResultSetColumnMetaData::IsCurrency ( )

Checks if the ResultSet column is of the type currency/money.

Returns
TRUE if a currency type; FALSE if otherwise.
Since
Version 1.0

◆ IsNullable()

const dtBOOLEAN dbSpaces::dbcli::ResultSetColumnMetaData::IsNullable ( )

Checks if the ResultSet column is nullable.

Returns
TRUE if nullable; FALSE if otherwise.
Since
Version 1.0

◆ IsSigned()

const dtBOOLEAN dbSpaces::dbcli::ResultSetColumnMetaData::IsSigned ( )

Checks if the ResultSet column is signed.

Returns
TRUE if signed; FALSE if otherwise.
Since
Version 1.0

◆ IsValidColumn()

const dtBOOLEAN dbSpaces::dbcli::ResultSetColumnMetaData::IsValidColumn ( ) const