ArrayDefine, base class for defines for use with the ArrayDataReader class. More...

#include <HOCI.h>

Inheritance diagram for Harlinn::OCI::ArrayDefine:

Collaboration diagram for Harlinn::OCI::ArrayDefine:

Public Member Functions
size_t	Count () const

Int16	Indicator (size_t index) const

virtual const void *	Data (size_t index) const noexcept=0

virtual HO_EXPORT bool	AsBoolean (size_t index) const

virtual HO_EXPORT Byte	AsByte (size_t index) const

virtual HO_EXPORT SByte	AsSByte (size_t index) const

virtual HO_EXPORT std::vector< Byte >	AsBytes (size_t index) const

virtual HO_EXPORT Int16	AsInt16 (size_t index) const

virtual HO_EXPORT UInt16	AsUInt16 (size_t index) const

virtual HO_EXPORT Int32	AsInt32 (size_t index) const

virtual HO_EXPORT UInt32	AsUInt32 (size_t index) const

virtual HO_EXPORT Int64	AsInt64 (size_t index) const

virtual HO_EXPORT UInt64	AsUInt64 (size_t index) const

virtual HO_EXPORT float	AsSingle (size_t index) const

virtual HO_EXPORT double	AsDouble (size_t index) const

virtual HO_EXPORT DateTime	AsDateTime (size_t index) const

virtual HO_EXPORT TimeSpan	AsTimeSpan (size_t index) const

virtual HO_EXPORT WideString	AsString (size_t index) const

virtual HO_EXPORT Guid	AsGuid (size_t index) const

virtual HO_EXPORT OCI::Object *	AsObject (size_t index) const

virtual HO_EXPORT OCI::Collection *	AsCollection (size_t index) const

virtual HO_EXPORT LobStream	AsStream (size_t index) const

Public Member Functions inherited from Harlinn::OCI::DefineBase
HO_EXPORT void	DefineByPos (UInt32 positon, OraType dataType, void dataAddress, Int64 dataSize, Int16 indicators, UInt32 returnLengths=nullptr, UInt16 returnCodes=nullptr, UInt32 mode=0)

virtual void	Initialize (UInt32 positon)=0

const OCI::Statement &	Statement () const noexcept

const OCI::ErrorHandle &	Error () const noexcept final override
	Provides access to the OCIError that will be used for OCI calls for this object.

const OCI::ServiceContext &	ServiceContext () const

const OCI::Environment &	Environment () const

HO_EXPORT void	SetLOBPrefetchSize (UInt32 lobPrefetchSize)

HO_EXPORT UInt32	LOBPrefetchSize () const

HO_EXPORT void	SetLOBPrefetchLength (bool value=true)

HO_EXPORT bool	LOBPrefetchLength () const

Public Member Functions inherited from Harlinn::OCI::HandleBase
constexpr void *	Handle () const noexcept
	Provides access to the value of the handle object.

constexpr	operator bool () const noexcept
	Test if the handle value is assigned.

constexpr bool	IsValid () const noexcept
	Test if the handle value is assigned.

constexpr OCI::HandleType	HandleType () const noexcept
	Returns a value identifying the type of the wrapped handle object.

Static Public Member Functions
static HO_EXPORT std::unique_ptr< ArrayDefine >	CreateDefine (const OCI::Statement &statement, size_t defineSize, const ColumnDescriptor &columnDescriptor, UInt32 positon)

Protected Member Functions
	ArrayDefine () noexcept

	ArrayDefine (const OCI::Statement &statement, size_t arraySize)

void	DefineByPos (UInt32 positon, OraType dataType, void dataAddress, Int64 dataSize, Int16 indicators, UInt32 returnLengths, UInt16 returnCodes, UInt32 mode)

HO_EXPORT void	DefineByPos (UInt32 positon, OraType dataType, void dataAddress, Int64 dataSize, UInt32 returnLengths=nullptr, UInt16 *returnCodes=nullptr, UInt32 mode=0)

Protected Member Functions inherited from Harlinn::OCI::DefineBase
	DefineBase (const OCI::Statement &statement)

constexpr	DefineBase () noexcept

Protected Member Functions inherited from Harlinn::OCI::HandleBase
constexpr	HandleBase () noexcept
	Default constructor.

constexpr	HandleBase (OCI::HandleType handleType, void *handle, bool ownsHandle) noexcept
	Constructs a new HandleBase object.

	HandleBase (const HandleBase &other)=delete

constexpr	HandleBase (HandleBase &&other) noexcept
	Move constructor.

virtual	~HandleBase ()
	Destructor.

constexpr void	SetHandle (void *newHandleValue, bool ownsHandle) noexcept
	Assigns the handle value and ownership to this object.

constexpr bool	OwnsHandle () const noexcept
	Returns true if this object is the owner of the handle value.

void *	DetachHandle ()
	If this object is the owner of a handle this function rescinds that ownership, and returns the handle value without closing the handle.

void	DestroyHandle ()
	Destroys the handle if it is owned by this object.

HandleBase &	operator= (const HandleBase &other)=delete

constexpr HandleBase &	operator= (HandleBase &&other) noexcept

constexpr void	swap (HandleBase &other) noexcept

template<typename Derived >
constexpr void	Take (Derived &&derived) noexcept
	Template function used to implement move assignement in derived classes.

void	InitializeHandle (void *handle, bool ownsHandle)
	Provides a "safe" mechanism for assigning a handle value. This functions throws if a handle value is already assigned to this object.

HO_EXPORT Int32	GetAttribute (void buffer, UInt32 size, Attribute attribute) const
	Gets the value of an attribute from the handle.

HO_EXPORT Int32	SetAttribute (void *buffer, UInt32 size, Attribute attribute) const
	Sets the value of an attribute on the handle.

DateTime	GetDateTimeAttribute (Attribute attribute) const
	Gets the value of an attribute from the handle as a DateTime.

void	SetDateTimeAttribute (Attribute attribute, const DateTime &value) const
	Sets the value of an attribute on the handle as a DateTime.

template<WideStringLike StringT = WideString>
StringT	GetStringAttribute (Attribute attribute) const
	Gets the value of an attribute from the handle as a WideString.

template<WideStringLike StringT = WideString>
StringT	GetStringAttributeFromByteString (Attribute attribute) const
	Gets the value of an attribute from the handle as a WideString For use with attributes that are not returned as UTF-16.

template<WideStringLike StringT>
void	SetStringAttribute (Attribute attribute, const StringT &value) const
	Sets the value of an attribute on the handle as a WideString.

void	SetStringAttribute (Attribute attribute, const wchar_t *value, size_t valueLength) const

bool	GetBooleanAttribute (Attribute attribute) const
	Gets the value of an attribute from the handle as a bool.

void	SetBooleanAttribute (Attribute attribute, bool value) const
	Sets the value of an attribute on the handle as a bool.

Byte	GetByteAttribute (Attribute attribute) const
	Gets the value of an attribute from the handle as a Byte.

void	SetByteAttribute (Attribute attribute, Byte value) const
	Sets the value of an attribute on the handle as a Byte.

SByte	GetSByteAttribute (Attribute attribute) const
	Gets the value of an attribute from the handle as a SByte.

void	SetSByteAttribute (Attribute attribute, SByte value) const
	Sets the value of an attribute on the handle as a Byte.

Int16	GetInt16Attribute (Attribute attribute) const
	Gets the value of an attribute from the handle as an Int16.

void	SetInt16Attribute (Attribute attribute, Int16 value) const
	Sets the value of an attribute on the handle as an Int16.

UInt16	GetUInt16Attribute (Attribute attribute) const
	Gets the value of an attribute from the handle as an UInt16.

void	SetUInt16Attribute (Attribute attribute, UInt16 value) const
	Sets the value of an attribute on the handle as an UInt16.

Int32	GetInt32Attribute (Attribute attribute) const
	Gets the value of an attribute from the handle as an Int32.

void	SetInt32Attribute (Attribute attribute, Int32 value) const
	Sets the value of an attribute on the handle as an Int32.

UInt32	GetUInt32Attribute (Attribute attribute) const
	Gets the value of an attribute from the handle as an UInt32.

void	SetUInt32Attribute (Attribute attribute, UInt32 value) const
	Sets the value of an attribute on the handle as an UInt32.

Int64	GetInt64Attribute (Attribute attribute) const
	Gets the value of an attribute from the handle as an Int64.

void	SetInt64Attribute (Attribute attribute, Int64 value) const
	Sets the value of an attribute on the handle as an Int64.

UInt64	GetUInt64Attribute (Attribute attribute) const
	Gets the value of an attribute from the handle as an UInt64.

void	SetUInt64Attribute (Attribute attribute, UInt64 value) const
	Sets the value of an attribute on the handle as an UInt64.

void *	GetPointerAttribute (Attribute attribute) const
	Gets the value of an attribute from the handle as a pointer.

void	SetPointerAttribute (Attribute attribute, void *value) const
	Sets the value of an attribute on the handle as a pointer.

OCI::Number *	GetNumberAttribute (Attribute attribute) const
	Gets the value of an attribute from the handle as a pointer to an OCI::Number.

Protected Attributes
std::vector< Int16 >	indicator_

Private Types
using	Base = DefineBase

Friends
class	ArrayDataReader

Additional Inherited Members
Static Protected Member Functions inherited from Harlinn::OCI::HandleBase
static HO_EXPORT void	HandleFree (void *handle, OCI::HandleType handleType) noexcept
	Calls OCIHandleFree to release the handle.

Detailed Description

ArrayDefine, base class for defines for use with the ArrayDataReader class.

Member Typedef Documentation

◆ Base

using Harlinn::OCI::ArrayDefine::Base = DefineBase

private

Constructor & Destructor Documentation

◆ ArrayDefine() [1/2]

Harlinn::OCI::ArrayDefine::ArrayDefine ( )

inlineprotectednoexcept

◆ ArrayDefine() [2/2]

Harlinn::OCI::ArrayDefine::ArrayDefine	(	const OCI::Statement &	statement,
		size_t	arraySize )

inlineprotected

Member Function Documentation

◆ AsBoolean()

bool Harlinn::OCI::ArrayDefine::AsBoolean ( size_t index ) const

virtual

Reimplemented in Harlinn::OCI::BinaryArrayDefine, Harlinn::OCI::CStringArrayDefine, Harlinn::OCI::DateArrayDefine, Harlinn::OCI::GuidArrayDefine, Harlinn::OCI::IntervalBaseArrayDefine< descriptorType, oracleType >, Harlinn::OCI::NumberArrayBaseDefine< externalType >, Harlinn::OCI::SimpleArrayDefine< BT, externalType >, Harlinn::OCI::TimestampBaseArrayDefine< descriptorType, oracleType >, and Harlinn::OCI::VarBinaryArrayDefine.

◆ AsByte()

Byte Harlinn::OCI::ArrayDefine::AsByte ( size_t index ) const

virtual

Reimplemented in Harlinn::OCI::BinaryArrayDefine, Harlinn::OCI::CStringArrayDefine, Harlinn::OCI::DateArrayDefine, Harlinn::OCI::IntervalBaseArrayDefine< descriptorType, oracleType >, Harlinn::OCI::NumberArrayBaseDefine< externalType >, Harlinn::OCI::SimpleArrayDefine< BT, externalType >, Harlinn::OCI::TimestampBaseArrayDefine< descriptorType, oracleType >, and Harlinn::OCI::VarBinaryArrayDefine.

◆ AsBytes()

std::vector< Byte > Harlinn::OCI::ArrayDefine::AsBytes ( size_t index ) const

virtual

Reimplemented in Harlinn::OCI::BinaryArrayDefine, Harlinn::OCI::CStringArrayDefine, Harlinn::OCI::DateArrayDefine, Harlinn::OCI::IntervalBaseArrayDefine< descriptorType, oracleType >, Harlinn::OCI::NumberArrayBaseDefine< externalType >, Harlinn::OCI::SimpleArrayDefine< BT, externalType >, Harlinn::OCI::TimestampBaseArrayDefine< descriptorType, oracleType >, and Harlinn::OCI::VarBinaryArrayDefine.

◆ AsCollection()

OCI::Collection * Harlinn::OCI::ArrayDefine::AsCollection ( size_t index ) const

virtual

◆ AsDateTime()

DateTime Harlinn::OCI::ArrayDefine::AsDateTime ( size_t index ) const

virtual

Reimplemented in Harlinn::OCI::BinaryArrayDefine, Harlinn::OCI::CStringArrayDefine, Harlinn::OCI::DateArrayDefine, Harlinn::OCI::IntervalBaseArrayDefine< descriptorType, oracleType >, Harlinn::OCI::NumberArrayBaseDefine< externalType >, Harlinn::OCI::SimpleArrayDefine< BT, externalType >, Harlinn::OCI::TimestampBaseArrayDefine< descriptorType, oracleType >, and Harlinn::OCI::VarBinaryArrayDefine.

◆ AsDouble()

double Harlinn::OCI::ArrayDefine::AsDouble ( size_t index ) const

virtual

Reimplemented in Harlinn::OCI::BinaryArrayDefine, Harlinn::OCI::CStringArrayDefine, Harlinn::OCI::DateArrayDefine, Harlinn::OCI::IntervalBaseArrayDefine< descriptorType, oracleType >, Harlinn::OCI::NumberArrayBaseDefine< externalType >, Harlinn::OCI::SimpleArrayDefine< BT, externalType >, Harlinn::OCI::TimestampBaseArrayDefine< descriptorType, oracleType >, and Harlinn::OCI::VarBinaryArrayDefine.

◆ AsGuid()

Guid Harlinn::OCI::ArrayDefine::AsGuid ( size_t index ) const

virtual

Reimplemented in Harlinn::OCI::BinaryArrayDefine, Harlinn::OCI::CStringArrayDefine, Harlinn::OCI::GuidArrayDefine, and Harlinn::OCI::VarBinaryArrayDefine.

◆ AsInt16()

short Harlinn::OCI::ArrayDefine::AsInt16 ( size_t index ) const

virtual

Reimplemented in Harlinn::OCI::BinaryArrayDefine, Harlinn::OCI::CStringArrayDefine, Harlinn::OCI::DateArrayDefine, Harlinn::OCI::IntervalBaseArrayDefine< descriptorType, oracleType >, Harlinn::OCI::NumberArrayBaseDefine< externalType >, Harlinn::OCI::SimpleArrayDefine< BT, externalType >, Harlinn::OCI::TimestampBaseArrayDefine< descriptorType, oracleType >, and Harlinn::OCI::VarBinaryArrayDefine.

◆ AsInt32()

Int32 Harlinn::OCI::ArrayDefine::AsInt32 ( size_t index ) const

virtual

Reimplemented in Harlinn::OCI::BinaryArrayDefine, Harlinn::OCI::CStringArrayDefine, Harlinn::OCI::DateArrayDefine, Harlinn::OCI::IntervalBaseArrayDefine< descriptorType, oracleType >, Harlinn::OCI::NumberArrayBaseDefine< externalType >, Harlinn::OCI::SimpleArrayDefine< BT, externalType >, Harlinn::OCI::TimestampBaseArrayDefine< descriptorType, oracleType >, and Harlinn::OCI::VarBinaryArrayDefine.

◆ AsInt64()

long long Harlinn::OCI::ArrayDefine::AsInt64 ( size_t index ) const

virtual

Reimplemented in Harlinn::OCI::BinaryArrayDefine, Harlinn::OCI::CStringArrayDefine, Harlinn::OCI::DateArrayDefine, Harlinn::OCI::IntervalBaseArrayDefine< descriptorType, oracleType >, Harlinn::OCI::NumberArrayBaseDefine< externalType >, Harlinn::OCI::SimpleArrayDefine< BT, externalType >, Harlinn::OCI::TimestampBaseArrayDefine< descriptorType, oracleType >, and Harlinn::OCI::VarBinaryArrayDefine.

◆ AsObject()

OCI::Object * Harlinn::OCI::ArrayDefine::AsObject ( size_t index ) const

virtual

◆ AsSByte()

SByte Harlinn::OCI::ArrayDefine::AsSByte ( size_t index ) const

virtual

Reimplemented in Harlinn::OCI::BinaryArrayDefine, Harlinn::OCI::CStringArrayDefine, Harlinn::OCI::DateArrayDefine, Harlinn::OCI::IntervalBaseArrayDefine< descriptorType, oracleType >, Harlinn::OCI::NumberArrayBaseDefine< externalType >, Harlinn::OCI::SimpleArrayDefine< BT, externalType >, Harlinn::OCI::TimestampBaseArrayDefine< descriptorType, oracleType >, and Harlinn::OCI::VarBinaryArrayDefine.

◆ AsSingle()

float Harlinn::OCI::ArrayDefine::AsSingle ( size_t index ) const

virtual

Reimplemented in Harlinn::OCI::BinaryArrayDefine, Harlinn::OCI::CStringArrayDefine, Harlinn::OCI::DateArrayDefine, Harlinn::OCI::IntervalBaseArrayDefine< descriptorType, oracleType >, Harlinn::OCI::NumberArrayBaseDefine< externalType >, Harlinn::OCI::SimpleArrayDefine< BT, externalType >, Harlinn::OCI::TimestampBaseArrayDefine< descriptorType, oracleType >, and Harlinn::OCI::VarBinaryArrayDefine.

◆ AsStream()

LobStream Harlinn::OCI::ArrayDefine::AsStream ( size_t index ) const

virtual

Reimplemented in Harlinn::OCI::LobArrayBaseDefine< oracleType >.

◆ AsString()

WideString Harlinn::OCI::ArrayDefine::AsString ( size_t index ) const

virtual

Reimplemented in Harlinn::OCI::BinaryArrayDefine, Harlinn::OCI::CLobArrayBaseDefine< oracleType, characterSetFormDefault >, Harlinn::OCI::CStringArrayDefine, Harlinn::OCI::DateArrayDefine, Harlinn::OCI::GuidArrayDefine, Harlinn::OCI::IntervalBaseArrayDefine< descriptorType, oracleType >, Harlinn::OCI::NumberArrayBaseDefine< externalType >, Harlinn::OCI::SimpleArrayDefine< BT, externalType >, Harlinn::OCI::TimestampBaseArrayDefine< descriptorType, oracleType >, and Harlinn::OCI::VarBinaryArrayDefine.

◆ AsTimeSpan()

TimeSpan Harlinn::OCI::ArrayDefine::AsTimeSpan ( size_t index ) const

virtual

Reimplemented in Harlinn::OCI::BinaryArrayDefine, Harlinn::OCI::CStringArrayDefine, Harlinn::OCI::DateArrayDefine, Harlinn::OCI::IntervalBaseArrayDefine< descriptorType, oracleType >, Harlinn::OCI::NumberArrayBaseDefine< externalType >, Harlinn::OCI::SimpleArrayDefine< BT, externalType >, Harlinn::OCI::TimestampBaseArrayDefine< descriptorType, oracleType >, and Harlinn::OCI::VarBinaryArrayDefine.

◆ AsUInt16()

UInt16 Harlinn::OCI::ArrayDefine::AsUInt16 ( size_t index ) const

virtual

Reimplemented in Harlinn::OCI::BinaryArrayDefine, Harlinn::OCI::CStringArrayDefine, Harlinn::OCI::DateArrayDefine, Harlinn::OCI::IntervalBaseArrayDefine< descriptorType, oracleType >, Harlinn::OCI::NumberArrayBaseDefine< externalType >, Harlinn::OCI::SimpleArrayDefine< BT, externalType >, Harlinn::OCI::TimestampBaseArrayDefine< descriptorType, oracleType >, and Harlinn::OCI::VarBinaryArrayDefine.

◆ AsUInt32()

UInt32 Harlinn::OCI::ArrayDefine::AsUInt32 ( size_t index ) const

virtual

Reimplemented in Harlinn::OCI::BinaryArrayDefine, Harlinn::OCI::CStringArrayDefine, Harlinn::OCI::DateArrayDefine, Harlinn::OCI::IntervalBaseArrayDefine< descriptorType, oracleType >, Harlinn::OCI::NumberArrayBaseDefine< externalType >, Harlinn::OCI::SimpleArrayDefine< BT, externalType >, Harlinn::OCI::TimestampBaseArrayDefine< descriptorType, oracleType >, and Harlinn::OCI::VarBinaryArrayDefine.

◆ AsUInt64()

UInt64 Harlinn::OCI::ArrayDefine::AsUInt64 ( size_t index ) const

virtual

Reimplemented in Harlinn::OCI::BinaryArrayDefine, Harlinn::OCI::CStringArrayDefine, Harlinn::OCI::DateArrayDefine, Harlinn::OCI::IntervalBaseArrayDefine< descriptorType, oracleType >, Harlinn::OCI::NumberArrayBaseDefine< externalType >, Harlinn::OCI::SimpleArrayDefine< BT, externalType >, Harlinn::OCI::TimestampBaseArrayDefine< descriptorType, oracleType >, and Harlinn::OCI::VarBinaryArrayDefine.

◆ Count()

size_t Harlinn::OCI::ArrayDefine::Count ( ) const

inline

◆ CreateDefine()

std::unique_ptr< ArrayDefine > Harlinn::OCI::ArrayDefine::CreateDefine	(	const OCI::Statement &	statement,
		size_t	defineSize,
		const ColumnDescriptor &	columnDescriptor,
		UInt32	positon )

static

◆ Data()

virtual const void * Harlinn::OCI::ArrayDefine::Data ( size_t index ) const

pure virtualnoexcept

Implemented in Harlinn::OCI::BinaryArrayDefine, Harlinn::OCI::CStringArrayDefine, Harlinn::OCI::DateArrayDefine, Harlinn::OCI::DescriptorArrayDefine< VT, descriptorType, oracleType >, Harlinn::OCI::DescriptorArrayDefine< OCIDateTime, descriptorType, oracleType >, Harlinn::OCI::DescriptorArrayDefine< OCIInterval, descriptorType, oracleType >, Harlinn::OCI::DescriptorArrayDefine< OCILobLocator, OCI::HandleType::LOB, oracleType >, Harlinn::OCI::FixedBinaryArrayDefine< binarySize >, Harlinn::OCI::FixedBinaryArrayDefine< sizeof(Guid)>, Harlinn::OCI::FixedStringArrayDefine< fixedStringSize >, Harlinn::OCI::NumberArrayBaseDefine< externalType >, Harlinn::OCI::SimpleArrayDefine< BT, externalType >, and Harlinn::OCI::VarBinaryArrayDefine.

◆ DefineByPos() [1/2]

void Harlinn::OCI::ArrayDefine::DefineByPos	(	UInt32	positon,
		OraType	dataType,
		void *	dataAddress,
		Int64	dataSize,
		Int16 *	indicators,
		UInt32 *	returnLengths,
		UInt16 *	returnCodes,
		UInt32	mode )

inlineprotected

◆ DefineByPos() [2/2]

void Harlinn::OCI::ArrayDefine::DefineByPos	(	UInt32	positon,
		OraType	dataType,
		void *	dataAddress,
		Int64	dataSize,
		UInt32 *	returnLengths = nullptr,
		UInt16 *	returnCodes = nullptr,
		UInt32	mode = 0 )

protected

◆ Indicator()

Int16 Harlinn::OCI::ArrayDefine::Indicator ( size_t index ) const

inline

Friends And Related Symbol Documentation

◆ ArrayDataReader

friend class ArrayDataReader

friend

Member Data Documentation

◆ indicator_

std::vector<Int16> Harlinn::OCI::ArrayDefine::indicator_

protected

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

C:/Src/Harlinn.Windows/Harlinn.OCI/HOCI.h
C:/Src/Harlinn.Windows/Harlinn.OCI/HOCIArrayDefine.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Base

Constructor & Destructor Documentation

◆ ArrayDefine() [1/2]

◆ ArrayDefine() [2/2]

Member Function Documentation

◆ AsBoolean()

◆ AsByte()

◆ AsBytes()

◆ AsCollection()

◆ AsDateTime()

◆ AsDouble()

◆ AsGuid()

◆ AsInt16()

◆ AsInt32()

◆ AsInt64()

◆ AsObject()

◆ AsSByte()

◆ AsSingle()

◆ AsStream()

◆ AsString()

◆ AsTimeSpan()

◆ AsUInt16()

◆ AsUInt32()

◆ AsUInt64()

◆ Count()

◆ CreateDefine()

◆ Data()

◆ DefineByPos() [1/2]

◆ DefineByPos() [2/2]

◆ Indicator()

Friends And Related Symbol Documentation

◆ ArrayDataReader

Member Data Documentation

◆ indicator_