#include <HOCI.h>

Inheritance diagram for Harlinn::OCI::ArgumentDescriptor:

Collaboration diagram for Harlinn::OCI::ArgumentDescriptor:

Public Member Functions
constexpr	ArgumentDescriptor () noexcept

constexpr	ArgumentDescriptor (const OCI::ServiceContext &serviceContext, OCIParam *handle, bool ownsHande=true)

WideString	Name () const
	Retrieves the argument name.

OCI::TypeCode	TypeCode () const
	Retreives the Typecode of the argument.

OCI::OraType	DataType () const
	Retreives the datatype of the argument.

UInt16	Length () const
	The size of the data type of the argument. This length is returned in bytes and not characters for strings and raws.It returns 22 for NUMBERs.

Int16	Precision (bool implicitDescribe=true) const
	The precision of numeric arguments. If the precision is nonzero and scale is -127, then it is a FLOAT; otherwise, it is a NUMBER(precision, scale). When precision is 0, NUMBER(precision, scale) can be represented simply as NUMBER.

SByte	Scale () const
	The scale of numeric arguments. If the precision is nonzero and scale is -127, then it is a FLOAT; otherwise, it is a NUMBER(precision, scale). When precision is 0, NUMBER(precision, scale) can be represented simply as NUMBER.

bool	HasDefault () const
	Indicates whether an argument has a default.

std::unique_ptr< ListDescriptor >	ListArguments () const
	The list of arguments at the next level (when the argument is of a record or table type)

TypeParamMode	InOutMode () const
	Indicates the argument In/Out/InOut mode.

Byte	Radix () const
	Returns a radix (if number type)

bool	IsNull () const
	Returns false if null values are not permitted for the column.

bool	Nullable () const
	Returns false if null values are not permitted for the column.

WideString	TypeName () const
	Returns a string that is the type name or the package name for package local types. The returned value contains the type name if the data type is SQLT_NTY or SQLT_REF. If the data type is SQLT_NTY, the name of the named data type's type is returned. If the data type is SQLT_REF, the type name of the named data type pointed to by the REF is returned.

WideString	SchemaName () const
	For SQLT_NTY or SQLT_REF, returns a string with the schema name under which the type was created, or under which the package was created for package local types.

WideString	SubName () const
	For SQLT_NTY or SQLT_REF, returns a string with the type name, for package local types.

WideString	Link () const
	For SQLT_NTY or SQLT_REF, returns a string with the database link name of the database on which the type exists.This can happen only for package local types, when the package is remote.

OCI::CharacterSetForm	CharacterSetForm () const
	Character set form.

Public Member Functions inherited from Harlinn::OCI::ParameterDescriptor
constexpr	ParameterDescriptor () noexcept

constexpr	ParameterDescriptor (const OCI::ServiceContext &serviceContext, OCIParam *handle, bool ownsHandle=true) noexcept

	ParameterDescriptor (const OCI::ServiceContext &serviceContext)

DateTime	Timestamp () const
	The timestamp of the object on which the description is based.

Public Member Functions inherited from Harlinn::OCI::Descriptor
constexpr	Descriptor () noexcept

	Descriptor (const Descriptor &other)=delete

constexpr	Descriptor (Descriptor &&other) noexcept

constexpr	Descriptor (const OCI::ServiceContext &serviceContext, OCI::HandleType handleType, void *handle, bool ownsHandle=true) noexcept
	Constructs a new Descriptor object.

	Descriptor (const OCI::ServiceContext &serviceContext, OCI::HandleType handleType)
	Allocates a descriptor of the specified type and constructs a new Descriptor object.

HO_EXPORT	~Descriptor ()

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

Descriptor &	operator= (Descriptor &&other) noexcept

const OCI::ServiceContext &	ServiceContext () const

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::Environment &	Environment () const

UInt32	Id () const
	Object or schema ID.

WideString	Name () const
	Database name or object name in a schema.

WideString	Schema () const
	Schema name where the object is located.

OCI::ParameterType	ParameterType () 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.

Private Types
using	Base = ParameterDescriptor

Additional Inherited Members
Static Public Member Functions inherited from Harlinn::OCI::ParameterDescriptor
static HO_EXPORT std::unique_ptr< ParameterDescriptor >	CreateParameter (const OCI::ServiceContext &serviceContext, OCIParam *handle, bool ownsHandle=true)

Static Public Member Functions inherited from Harlinn::OCI::Descriptor
static HO_EXPORT void *	DescriptorAlloc (const OCI::ServiceContext &serviceContext, OCI::HandleType handleType)

static HO_EXPORT void	DescriptorFree (void *handle, OCI::HandleType handleType)

Protected Member Functions inherited from Harlinn::OCI::ParameterDescriptor
HO_EXPORT std::unique_ptr< ParameterDescriptor >	GetChildDescriptor (size_t index) const
	Retrieves the ParameterDescriptor at index.

HO_EXPORT std::unique_ptr< ParameterDescriptor >	GetChildDescriptor (void *listHandle, size_t index) const

Protected Member Functions inherited from Harlinn::OCI::Descriptor
template<typename T >
constexpr void	Take (T &&other) noexcept

WideString	GetStringAttribute (DescribeAttribute attributeId) const

void	SetStringAttribute (DescribeAttribute attribute, const WideString &value) const

bool	GetBooleanAttribute (DescribeAttribute attribute) const

void	SetBooleanAttribute (DescribeAttribute attribute, bool value) const

Byte	GetByteAttribute (DescribeAttribute attribute) const

void	SetByteAttribute (DescribeAttribute attribute, Byte value) const

SByte	GetSByteAttribute (DescribeAttribute attribute) const

void	SetSByteAttribute (DescribeAttribute attribute, SByte value) const

Int16	GetInt16Attribute (DescribeAttribute attribute) const

void	SetInt16Attribute (DescribeAttribute attribute, Int16 value) const

UInt16	GetUInt16Attribute (DescribeAttribute attribute) const

void	SetUInt16Attribute (DescribeAttribute attribute, UInt16 value) const

Int32	GetInt32Attribute (DescribeAttribute attribute) const

void	SetInt32Attribute (DescribeAttribute attribute, Int32 value) const

UInt32	GetUInt32Attribute (DescribeAttribute attribute) const

void	SetUInt32Attribute (DescribeAttribute attribute, UInt32 value) const

void *	GetPointerAttribute (DescribeAttribute attribute) const

void	SetPointerAttribute (DescribeAttribute attribute, void *value) const

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

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.

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.

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

ArgumentDescriptor.

Member Typedef Documentation

◆ Base

using Harlinn::OCI::ArgumentDescriptor::Base = ParameterDescriptor

private

Constructor & Destructor Documentation

◆ ArgumentDescriptor() [1/2]

Harlinn::OCI::ArgumentDescriptor::ArgumentDescriptor ( )

inlineconstexprnoexcept

◆ ArgumentDescriptor() [2/2]

Harlinn::OCI::ArgumentDescriptor::ArgumentDescriptor	(	const OCI::ServiceContext &	serviceContext,
		OCIParam *	handle,
		bool	ownsHande = true )

inlineconstexpr

Member Function Documentation

◆ CharacterSetForm()

OCI::CharacterSetForm Harlinn::OCI::ArgumentDescriptor::CharacterSetForm ( ) const

inline

Character set form.

◆ DataType()

OCI::OraType Harlinn::OCI::ArgumentDescriptor::DataType ( ) const

inline

Retreives the datatype of the argument.

◆ HasDefault()

bool Harlinn::OCI::ArgumentDescriptor::HasDefault ( ) const

inline

Indicates whether an argument has a default.

◆ InOutMode()

TypeParamMode Harlinn::OCI::ArgumentDescriptor::InOutMode ( ) const

inline

Indicates the argument In/Out/InOut mode.

◆ IsNull()

bool Harlinn::OCI::ArgumentDescriptor::IsNull ( ) const

inline

Returns false if null values are not permitted for the column.

Returns

◆ Length()

UInt16 Harlinn::OCI::ArgumentDescriptor::Length ( ) const

inline

The size of the data type of the argument. This length is returned in bytes and not characters for strings and raws.It returns 22 for NUMBERs.

◆ Link()

WideString Harlinn::OCI::ArgumentDescriptor::Link ( ) const

inline

For SQLT_NTY or SQLT_REF, returns a string with the database link name of the database on which the type exists.This can happen only for package local types, when the package is remote.

◆ ListArguments()

std::unique_ptr< ListDescriptor > Harlinn::OCI::ArgumentDescriptor::ListArguments ( ) const

inline

The list of arguments at the next level (when the argument is of a record or table type)

◆ Name()

WideString Harlinn::OCI::ArgumentDescriptor::Name ( ) const

inline

Retrieves the argument name.

◆ Nullable()

bool Harlinn::OCI::ArgumentDescriptor::Nullable ( ) const

inline

Returns false if null values are not permitted for the column.

Returns

◆ Precision()

Int16 Harlinn::OCI::ArgumentDescriptor::Precision ( bool implicitDescribe = true ) const

inline

The precision of numeric arguments. If the precision is nonzero and scale is -127, then it is a FLOAT; otherwise, it is a NUMBER(precision, scale). When precision is 0, NUMBER(precision, scale) can be represented simply as NUMBER.

Parameters

implicitDescribe

Returns

◆ Radix()

Byte Harlinn::OCI::ArgumentDescriptor::Radix ( ) const

inline

Returns a radix (if number type)

◆ Scale()

SByte Harlinn::OCI::ArgumentDescriptor::Scale ( ) const

inline

The scale of numeric arguments. If the precision is nonzero and scale is -127, then it is a FLOAT; otherwise, it is a NUMBER(precision, scale). When precision is 0, NUMBER(precision, scale) can be represented simply as NUMBER.

◆ SchemaName()

WideString Harlinn::OCI::ArgumentDescriptor::SchemaName ( ) const

inline

For SQLT_NTY or SQLT_REF, returns a string with the schema name under which the type was created, or under which the package was created for package local types.

◆ SubName()

WideString Harlinn::OCI::ArgumentDescriptor::SubName ( ) const

inline

For SQLT_NTY or SQLT_REF, returns a string with the type name, for package local types.

◆ TypeCode()

OCI::TypeCode Harlinn::OCI::ArgumentDescriptor::TypeCode ( ) const

inline

Retreives the Typecode of the argument.

◆ TypeName()

WideString Harlinn::OCI::ArgumentDescriptor::TypeName ( ) const

inline

Returns a string that is the type name or the package name for package local types. The returned value contains the type name if the data type is SQLT_NTY or SQLT_REF. If the data type is SQLT_NTY, the name of the named data type's type is returned. If the data type is SQLT_REF, the type name of the named data type pointed to by the REF is returned.

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

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

Public Member Functions

Private Types

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Base

Constructor & Destructor Documentation

◆ ArgumentDescriptor() [1/2]

◆ ArgumentDescriptor() [2/2]

Member Function Documentation

◆ CharacterSetForm()

◆ DataType()

◆ HasDefault()

◆ InOutMode()

◆ IsNull()

◆ Length()

◆ Link()

◆ ListArguments()

◆ Name()

◆ Nullable()

◆ Precision()

◆ Radix()

◆ Scale()

◆ SchemaName()

◆ SubName()

◆ TypeCode()

◆ TypeName()