Harlinn::OCI::DefineBase Class Reference

DefineBase, base class for all defines. More...

#include <HOCI.h>

Inheritance diagram for Harlinn::OCI::DefineBase:

Collaboration diagram for Harlinn::OCI::DefineBase:

Public Member Functions
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.

Protected Member Functions
	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.

Private Types
using	Base = HandleBase

Private Attributes
OCI::Statement *	statement_

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

DefineBase, base class for all defines.

Member Typedef Documentation

Base

using Harlinn::OCI::DefineBase::Base = HandleBase

private

Constructor & Destructor Documentation

DefineBase() [1/2]

Harlinn::OCI::DefineBase::DefineBase ( const OCI::Statement & statement )

inlineprotected

DefineBase() [2/2]

Harlinn::OCI::DefineBase::DefineBase ( )

inlineconstexprprotectednoexcept

Member Function Documentation

DefineByPos()

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

Environment()

const OCI::Environment & Harlinn::OCI::DefineBase::Environment ( ) const

inline

Error()

const OCI::ErrorHandle & Harlinn::OCI::DefineBase::Error ( ) const

inlinefinaloverridevirtualnoexcept

Provides access to the OCIError that will be used for OCI calls for this object.

Returns

Implements Harlinn::OCI::HandleBase.

Initialize()

virtual void Harlinn::OCI::DefineBase::Initialize ( UInt32 positon )

pure virtual

Implemented in Harlinn::OCI::BinaryArrayDefine, Harlinn::OCI::BinaryDefine, Harlinn::OCI::CollectionDefine, Harlinn::OCI::CStringArrayDefine, Harlinn::OCI::CStringDefine, Harlinn::OCI::DateArrayDefine, Harlinn::OCI::DateDefine, Harlinn::OCI::Define, 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::DescriptorDefine< VT, descriptorType, oracleType >, Harlinn::OCI::DescriptorDefine< OCIDateTime, descriptorType, oracleType >, Harlinn::OCI::DescriptorDefine< OCIInterval, descriptorType, oracleType >, Harlinn::OCI::DescriptorDefine< OCILobLocator, OCI::HandleType::LOB, oracleType >, Harlinn::OCI::DynamicLongRawDefine, Harlinn::OCI::FixedBinaryArrayDefine< binarySize >, Harlinn::OCI::FixedBinaryArrayDefine< sizeof(Guid)>, Harlinn::OCI::FixedBinaryDefine< binarySize >, Harlinn::OCI::FixedBinaryDefine< sizeof(Guid)>, Harlinn::OCI::FixedStringArrayDefine< fixedStringSize >, Harlinn::OCI::FixedStringDefine< fixedStringSize >, Harlinn::OCI::LongVarBinaryDefine, Harlinn::OCI::NumberArrayBaseDefine< externalType >, Harlinn::OCI::NumberBaseDefine< externalType >, Harlinn::OCI::ObjectDefine, Harlinn::OCI::SimpleArrayDefine< BT, externalType >, Harlinn::OCI::SimpleDefine< BT, externalType >, Harlinn::OCI::VarBinaryArrayDefine, and Harlinn::OCI::VarBinaryDefine.

LOBPrefetchLength()

bool Harlinn::OCI::DefineBase::LOBPrefetchLength

(

)

const

LOBPrefetchSize()

UInt32 Harlinn::OCI::DefineBase::LOBPrefetchSize

(

)

const

ServiceContext()

const OCI::ServiceContext & Harlinn::OCI::DefineBase::ServiceContext ( ) const

inline

SetLOBPrefetchLength()

void Harlinn::OCI::DefineBase::SetLOBPrefetchLength

(

bool

value = true

)

SetLOBPrefetchSize()

void Harlinn::OCI::DefineBase::SetLOBPrefetchSize

(

UInt32

lobPrefetchSize

)

Statement()

const OCI::Statement & Harlinn::OCI::DefineBase::Statement ( ) const

inlinenoexcept

Member Data Documentation

statement_

OCI::Statement* Harlinn::OCI::DefineBase::statement_

private

---

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/HOCIDefineBase.cpp