#include <HOCI.h>

Inheritance diagram for Harlinn::OCI::Describe:

Collaboration diagram for Harlinn::OCI::Describe:

Public Member Functions
constexpr	Describe () noexcept

constexpr	Describe (const OCI::ServiceContext &serviceContext, void *ociDescribe, bool ownsHandle=true) noexcept

	Describe (const Describe &other)=delete

constexpr	Describe (Describe &&other) noexcept

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

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

const OCI::Environment &	Environment () const

const OCI::ServiceContext &	ServiceContext () 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.

HO_EXPORT void	DescribeAny (const WideString &objectName, OCI::ParameterType parameterType=OCI::ParameterType::Unknown) const

HO_EXPORT void	DescribeAny (const OCI::Type &type) const

HO_EXPORT void	DescribeAny (OCIType *type) const

HO_EXPORT void	DescribeAny (const OCI::Ref &typeRef) const

HO_EXPORT void	DescribeAny (OCIRef *typeRef) const

HO_EXPORT std::unique_ptr< ParameterDescriptor >	_Descriptor () const
	Return a ParameterDescriptor that points to the root of the description.

template<typename T > requires std::is_base_of_v<ParameterDescriptor,T>
std::unique_ptr< T >	Descriptor () const
	Return a ParameterDescriptor that points to the root of the description.

template<typename T > requires std::is_base_of_v<ParameterDescriptor, T>
std::unique_ptr< ParameterDescriptor >	Param () const
	Return a ParameterDescriptor that points to the root of the description.

UInt32	ParamCount () const
	Returns the number of parameters in the describe handle. When the describe handle is a description of the select list, this refers to the number of columns in the select list.

void	ShowInvisibleColumns (bool value)
	This attribute requests the Describe to also get the metadata for invisible columns.

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 Attributes
static constexpr OCI::HandleType	OCIHandleType = OCI::HandleType::Describe

Private Types
using	Base = HandleBase

Private Attributes
const OCI::ServiceContext *	serviceContext_

Additional Inherited Members
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.

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

Describe.

Member Typedef Documentation

◆ Base

using Harlinn::OCI::Describe::Base = HandleBase

private

Constructor & Destructor Documentation

◆ Describe() [1/4]

Harlinn::OCI::Describe::Describe ( )

inlineconstexprnoexcept

◆ Describe() [2/4]

Harlinn::OCI::Describe::Describe	(	const OCI::ServiceContext &	serviceContext,
		void *	ociDescribe,
		bool	ownsHandle = true )

inlineconstexprnoexcept

◆ Describe() [3/4]

Harlinn::OCI::Describe::Describe ( const Describe & other )

delete

◆ Describe() [4/4]

Harlinn::OCI::Describe::Describe ( Describe && other )

inlineconstexprnoexcept

Member Function Documentation

◆ _Descriptor()

std::unique_ptr< ParameterDescriptor > Harlinn::OCI::Describe::_Descriptor ( ) const

Return a ParameterDescriptor that points to the root of the description.

Returns: The root ParameterDescriptor

◆ DescribeAny() [1/5]

void Harlinn::OCI::Describe::DescribeAny ( const OCI::Ref & typeRef ) const

◆ DescribeAny() [2/5]

void Harlinn::OCI::Describe::DescribeAny ( const OCI::Type & type ) const

◆ DescribeAny() [3/5]

void Harlinn::OCI::Describe::DescribeAny	(	const WideString &	objectName,
		OCI::ParameterType	parameterType = OCI::ParameterType::Unknown ) const

◆ DescribeAny() [4/5]

void Harlinn::OCI::Describe::DescribeAny ( OCIRef * typeRef ) const

◆ DescribeAny() [5/5]

void Harlinn::OCI::Describe::DescribeAny ( OCIType * type ) const

◆ Descriptor()

template<typename T >
requires std::is_base_of_v<ParameterDescriptor,T>

std::unique_ptr< T > Harlinn::OCI::Describe::Descriptor ( ) const

inline

Return a ParameterDescriptor that points to the root of the description.

Returns: The root ParameterDescriptor

◆ Environment()

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

inline

◆ Error()

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

inlinefinaloverridevirtualnoexcept

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

Returns

Implements Harlinn::OCI::HandleBase.

◆ operator=() [1/2]

Describe & Harlinn::OCI::Describe::operator= ( const Describe & other )

delete

◆ operator=() [2/2]

Describe & Harlinn::OCI::Describe::operator= ( Describe && other )

inlineconstexprnoexcept

◆ Param()

template<typename T >
requires std::is_base_of_v<ParameterDescriptor, T>

std::unique_ptr< ParameterDescriptor > Harlinn::OCI::Describe::Param ( ) const

inline

Return a ParameterDescriptor that points to the root of the description.

Returns: The root ParameterDescriptor

◆ ParamCount()

UInt32 Harlinn::OCI::Describe::ParamCount ( ) const

inline

Returns the number of parameters in the describe handle. When the describe handle is a description of the select list, this refers to the number of columns in the select list.

Returns: the number of parameters in the describe handle

◆ ServiceContext()

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

inlinenoexcept

◆ ShowInvisibleColumns()

void Harlinn::OCI::Describe::ShowInvisibleColumns ( bool value )

inline

This attribute requests the Describe to also get the metadata for invisible columns.

Parameters

value

Member Data Documentation

◆ OCIHandleType

OCI::HandleType Harlinn::OCI::Describe::OCIHandleType = OCI::HandleType::Describe

staticconstexpr

◆ serviceContext_

const OCI::ServiceContext* Harlinn::OCI::Describe::serviceContext_

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

Public Member Functions

Static Public Attributes

Private Types

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Base

Constructor & Destructor Documentation

◆ Describe() [1/4]

◆ Describe() [2/4]

◆ Describe() [3/4]

◆ Describe() [4/4]

Member Function Documentation

◆ _Descriptor()

◆ DescribeAny() [1/5]

◆ DescribeAny() [2/5]

◆ DescribeAny() [3/5]

◆ DescribeAny() [4/5]

◆ DescribeAny() [5/5]

◆ Descriptor()

◆ Environment()

◆ Error()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ Param()

◆ ParamCount()

◆ ServiceContext()

◆ ShowInvisibleColumns()

Member Data Documentation

◆ OCIHandleType

◆ serviceContext_