Harlinn.Windows 0.1
Loading...
Searching...
No Matches
Harlinn::ODBC::Descriptor Class Reference

A descriptor is a collection of metadata that describes the parameters of an SQL statement or the columns of a result set, as seen by the application or driver. More...

#include <HODBC.h>

Inheritance diagram for Harlinn::ODBC::Descriptor:
[legend]
Collaboration diagram for Harlinn::ODBC::Descriptor:
[legend]

Public Types

using Base = SqlHandle<ODBC::HandleType::Descriptor>
 

Public Member Functions

constexpr Descriptor ()
 
Result CopyTo (const Descriptor &other) const
 Copies the descriptor information to another descriptor.
 
Result CopyFrom (const Descriptor &other) const
 Copies the descriptor information from another descriptor.
 
Result GetFieldW (SQLSMALLINT recordNumber, SQLSMALLINT fieldIdentifier, SQLPOINTER value, SQLINTEGER valueMaxLength, SQLINTEGER *valueActualLength) const
 Retrieves the current value of a single field of a descriptor record.
 
UInt16 GetUInt16Field (SQLSMALLINT recordNumber, SQLSMALLINT fieldIdentifier) const
 
Int16 GetInt16Field (SQLSMALLINT recordNumber, SQLSMALLINT fieldIdentifier) const
 
UInt64 GetUInt64Field (SQLSMALLINT recordNumber, SQLSMALLINT fieldIdentifier) const
 
Int64 GetInt64Field (SQLSMALLINT recordNumber, SQLSMALLINT fieldIdentifier) const
 
SQLPOINTER GetPointerField (SQLSMALLINT recordNumber, SQLSMALLINT fieldIdentifier) const
 
WideString GetWideStringField (SQLSMALLINT recordNumber, SQLSMALLINT fieldIdentifier) const
 
Result GetFieldA (SQLSMALLINT recordNumber, SQLSMALLINT fieldIdentifier, SQLPOINTER value, SQLINTEGER valueMaxLength, SQLINTEGER *valueActualLength) const
 
Result GetRecord (SQLSMALLINT recordNumber, SQLWCHAR *name, SQLSMALLINT nameMaxLength, SQLSMALLINT *nameActualLength, SQLSMALLINT *type, SQLSMALLINT *subType, SQLLEN *length, SQLSMALLINT *precision, SQLSMALLINT *scale, SQLSMALLINT *nullable) const
 
Result GetRecord (SQLSMALLINT recordNumber, SQLCHAR *name, SQLSMALLINT nameMaxLength, SQLSMALLINT *nameActualLength, SQLSMALLINT *type, SQLSMALLINT *subType, SQLLEN *length, SQLSMALLINT *precision, SQLSMALLINT *scale, SQLSMALLINT *nullable) const
 
Result SetFieldW (SQLSMALLINT recordNumber, SQLSMALLINT fieldIdentifier, SQLPOINTER value, SQLINTEGER valueLength) const
 
Result SetUInt16Field (SQLSMALLINT recordNumber, SQLSMALLINT fieldIdentifier, UInt16 value) const
 
Result SetInt16Field (SQLSMALLINT recordNumber, SQLSMALLINT fieldIdentifier, Int16 value) const
 
Result SetUInt64Field (SQLSMALLINT recordNumber, SQLSMALLINT fieldIdentifier, UInt64 value) const
 
Result SetInt64Field (SQLSMALLINT recordNumber, SQLSMALLINT fieldIdentifier, Int64 value) const
 
Result SetPointerField (SQLSMALLINT recordNumber, SQLSMALLINT fieldIdentifier, SQLPOINTER value) const
 
Result SetFieldA (SQLSMALLINT recordNumber, SQLSMALLINT fieldIdentifier, SQLPOINTER value, SQLINTEGER valueLength) const
 
Result SetRecord (SQLSMALLINT recordNumber, SQLSMALLINT type, SQLSMALLINT subType, SQLLEN length, SQLSMALLINT precision, SQLSMALLINT scale, SQLPOINTER data, SQLLEN *dataLength, SQLLEN *indicator) const
 
bool UserAllocated () const
 
Result SetArraySize (size_t arraySize) const
 
size_t ArraySize () const
 
Result SetStatusArrayPointer (SQLUSMALLINT *statusArray) const
 
SQLUSMALLINT * StatusArrayPointer () const
 
Result SetBindOffsetPointer (SQLLEN *bindOffsetPointer) const
 
SQLLEN * BindOffsetPointer () const
 
Result SetBindByColumn () const
 
bool BindByColumn () const
 
Int16 RecordCount () const
 
Result SetRowsProcessedPointer (SQLULEN *bindOffsetPointer) const
 
SQLULEN * RowsProcessedPointer () const
 
- Public Member Functions inherited from Harlinn::ODBC::SqlHandle< ODBC::HandleType::Descriptor >
constexpr SqlHandle () noexcept
 
 SqlHandle (const SqlHandle &other)=delete
 
constexpr SqlHandle (SqlHandle &&other) noexcept
 
 ~SqlHandle ()
 
SqlHandleoperator= (const SqlHandle &other)=delete
 
constexpr SqlHandleoperator= (SqlHandle &&other) noexcept
 
constexpr SQLHANDLE Handle () const noexcept
 
void Close () noexcept
 
Result Cancel () const
 
Result CompleteAsync (RETCODE *asyncRetCode) const
 

Private Member Functions

constexpr Descriptor (SQLHANDLE sqlHandle, bool destructorClosesHandle=true)
 

Friends

class Statement
 
class Connection
 
class Environment
 

Additional Inherited Members

- Static Public Attributes inherited from Harlinn::ODBC::SqlHandle< ODBC::HandleType::Descriptor >
static constexpr ODBC::HandleType HandleType
 
static constexpr SQLHANDLE InvalidHandle
 
- Protected Member Functions inherited from Harlinn::ODBC::SqlHandle< ODBC::HandleType::Descriptor >
constexpr SqlHandle (SQLHANDLE sqlHandle, bool destructorClosesHandle) noexcept
 
void SetHandle (SQLHANDLE sqlHandle, bool destructorClosesHandle)
 
void ThrowException (SQLRETURN sqlReturn) const
 
void ThrowException (SQLRETURN sqlReturn, const wchar_t *function, const wchar_t *file, int line) const
 
- Static Protected Member Functions inherited from Harlinn::ODBC::SqlHandle< ODBC::HandleType::Descriptor >
static SQLHANDLE AllocateHandle (SQLHANDLE inputHandle=SQL_NULL_HANDLE, ODBC::HandleType handleType=HandleType)
 

Detailed Description

A descriptor is a collection of metadata that describes the parameters of an SQL statement or the columns of a result set, as seen by the application or driver.

Member Typedef Documentation

◆ Base

Constructor & Destructor Documentation

◆ Descriptor() [1/2]

Harlinn::ODBC::Descriptor::Descriptor ( )
inlineconstexpr

◆ Descriptor() [2/2]

Harlinn::ODBC::Descriptor::Descriptor ( SQLHANDLE sqlHandle,
bool destructorClosesHandle = true )
inlineexplicitconstexprprivate

Member Function Documentation

◆ ArraySize()

size_t Harlinn::ODBC::Descriptor::ArraySize ( ) const
inline

◆ BindByColumn()

bool Harlinn::ODBC::Descriptor::BindByColumn ( ) const
inline

◆ BindOffsetPointer()

SQLLEN * Harlinn::ODBC::Descriptor::BindOffsetPointer ( ) const
inline

◆ CopyFrom()

Result Harlinn::ODBC::Descriptor::CopyFrom ( const Descriptor & other) const
inline

Copies the descriptor information from another descriptor.

Parameters
otherSource descriptor handle
Returns
Result::Success or Result::SuccessWithInfo

◆ CopyTo()

Result Harlinn::ODBC::Descriptor::CopyTo ( const Descriptor & other) const
inline

Copies the descriptor information to another descriptor.

Parameters
otherDestination descriptor handle
Returns
Result::Success or Result::SuccessWithInfo

◆ GetFieldA()

Result Harlinn::ODBC::Descriptor::GetFieldA ( SQLSMALLINT recordNumber,
SQLSMALLINT fieldIdentifier,
SQLPOINTER value,
SQLINTEGER valueMaxLength,
SQLINTEGER * valueActualLength ) const
inline

◆ GetFieldW()

Result Harlinn::ODBC::Descriptor::GetFieldW ( SQLSMALLINT recordNumber,
SQLSMALLINT fieldIdentifier,
SQLPOINTER value,
SQLINTEGER valueMaxLength,
SQLINTEGER * valueActualLength ) const
inline

Retrieves the current value of a single field of a descriptor record.

Parameters
recordNumberIdentifies the descriptor record from which the application seeks information
fieldIdentifierIdentifies the field of the descriptor whose value is to be returned
valuePointer to a buffer that will recieve the value of the requested field
valueMaxLength
valueActualLength
Returns

◆ GetInt16Field()

Int16 Harlinn::ODBC::Descriptor::GetInt16Field ( SQLSMALLINT recordNumber,
SQLSMALLINT fieldIdentifier ) const
inline

◆ GetInt64Field()

Int64 Harlinn::ODBC::Descriptor::GetInt64Field ( SQLSMALLINT recordNumber,
SQLSMALLINT fieldIdentifier ) const
inline

◆ GetPointerField()

SQLPOINTER Harlinn::ODBC::Descriptor::GetPointerField ( SQLSMALLINT recordNumber,
SQLSMALLINT fieldIdentifier ) const
inline

◆ GetRecord() [1/2]

Result Harlinn::ODBC::Descriptor::GetRecord ( SQLSMALLINT recordNumber,
SQLCHAR * name,
SQLSMALLINT nameMaxLength,
SQLSMALLINT * nameActualLength,
SQLSMALLINT * type,
SQLSMALLINT * subType,
SQLLEN * length,
SQLSMALLINT * precision,
SQLSMALLINT * scale,
SQLSMALLINT * nullable ) const
inline

◆ GetRecord() [2/2]

Result Harlinn::ODBC::Descriptor::GetRecord ( SQLSMALLINT recordNumber,
SQLWCHAR * name,
SQLSMALLINT nameMaxLength,
SQLSMALLINT * nameActualLength,
SQLSMALLINT * type,
SQLSMALLINT * subType,
SQLLEN * length,
SQLSMALLINT * precision,
SQLSMALLINT * scale,
SQLSMALLINT * nullable ) const
inline

◆ GetUInt16Field()

UInt16 Harlinn::ODBC::Descriptor::GetUInt16Field ( SQLSMALLINT recordNumber,
SQLSMALLINT fieldIdentifier ) const
inline

◆ GetUInt64Field()

UInt64 Harlinn::ODBC::Descriptor::GetUInt64Field ( SQLSMALLINT recordNumber,
SQLSMALLINT fieldIdentifier ) const
inline

◆ GetWideStringField()

WideString Harlinn::ODBC::Descriptor::GetWideStringField ( SQLSMALLINT recordNumber,
SQLSMALLINT fieldIdentifier ) const
inline

◆ RecordCount()

Int16 Harlinn::ODBC::Descriptor::RecordCount ( ) const
inline

◆ RowsProcessedPointer()

SQLULEN * Harlinn::ODBC::Descriptor::RowsProcessedPointer ( ) const
inline

◆ SetArraySize()

Result Harlinn::ODBC::Descriptor::SetArraySize ( size_t arraySize) const
inline

◆ SetBindByColumn()

Result Harlinn::ODBC::Descriptor::SetBindByColumn ( ) const
inline

◆ SetBindOffsetPointer()

Result Harlinn::ODBC::Descriptor::SetBindOffsetPointer ( SQLLEN * bindOffsetPointer) const
inline

◆ SetFieldA()

Result Harlinn::ODBC::Descriptor::SetFieldA ( SQLSMALLINT recordNumber,
SQLSMALLINT fieldIdentifier,
SQLPOINTER value,
SQLINTEGER valueLength ) const
inline

◆ SetFieldW()

Result Harlinn::ODBC::Descriptor::SetFieldW ( SQLSMALLINT recordNumber,
SQLSMALLINT fieldIdentifier,
SQLPOINTER value,
SQLINTEGER valueLength ) const
inline

◆ SetInt16Field()

Result Harlinn::ODBC::Descriptor::SetInt16Field ( SQLSMALLINT recordNumber,
SQLSMALLINT fieldIdentifier,
Int16 value ) const
inline

◆ SetInt64Field()

Result Harlinn::ODBC::Descriptor::SetInt64Field ( SQLSMALLINT recordNumber,
SQLSMALLINT fieldIdentifier,
Int64 value ) const
inline

◆ SetPointerField()

Result Harlinn::ODBC::Descriptor::SetPointerField ( SQLSMALLINT recordNumber,
SQLSMALLINT fieldIdentifier,
SQLPOINTER value ) const
inline

◆ SetRecord()

Result Harlinn::ODBC::Descriptor::SetRecord ( SQLSMALLINT recordNumber,
SQLSMALLINT type,
SQLSMALLINT subType,
SQLLEN length,
SQLSMALLINT precision,
SQLSMALLINT scale,
SQLPOINTER data,
SQLLEN * dataLength,
SQLLEN * indicator ) const
inline

◆ SetRowsProcessedPointer()

Result Harlinn::ODBC::Descriptor::SetRowsProcessedPointer ( SQLULEN * bindOffsetPointer) const
inline

◆ SetStatusArrayPointer()

Result Harlinn::ODBC::Descriptor::SetStatusArrayPointer ( SQLUSMALLINT * statusArray) const
inline

◆ SetUInt16Field()

Result Harlinn::ODBC::Descriptor::SetUInt16Field ( SQLSMALLINT recordNumber,
SQLSMALLINT fieldIdentifier,
UInt16 value ) const
inline

◆ SetUInt64Field()

Result Harlinn::ODBC::Descriptor::SetUInt64Field ( SQLSMALLINT recordNumber,
SQLSMALLINT fieldIdentifier,
UInt64 value ) const
inline

◆ StatusArrayPointer()

SQLUSMALLINT * Harlinn::ODBC::Descriptor::StatusArrayPointer ( ) const
inline

◆ UserAllocated()

bool Harlinn::ODBC::Descriptor::UserAllocated ( ) const
inline

Friends And Related Symbol Documentation

◆ Connection

friend class Connection
friend

◆ Environment

friend class Environment
friend

◆ Statement

friend class Statement
friend

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