#include <HOCI.h>

Inheritance diagram for Harlinn::OCI::StringBind:

Collaboration diagram for Harlinn::OCI::StringBind:

Public Types
using	BoundType = WideString

Public Member Functions
	StringBind () noexcept

	StringBind (const OCI::Statement &statement)

	StringBind (const OCI::Statement &statement, UInt32 position, size_t maximumColumnSize=0)

	StringBind (const OCI::Statement &statement, const WideString &name)

	StringBind (const OCI::Statement &statement, UInt32 position, const WideString &value, size_t maximumColumnSize=0)

	StringBind (const OCI::Statement &statement, const WideString &name, const WideString &value, size_t maximumColumnSize=0)

virtual HO_EXPORT	~StringBind ()

virtual HO_EXPORT void *	Data () const override

virtual HO_EXPORT bool	AsBoolean () const override

virtual HO_EXPORT void	Assign (bool newValue) override

virtual HO_EXPORT Byte	AsByte () const override

virtual HO_EXPORT void	Assign (Byte newValue) override

virtual HO_EXPORT SByte	AsSByte () const override

virtual HO_EXPORT void	Assign (SByte newValue) override

virtual HO_EXPORT Int16	AsInt16 () const override

virtual HO_EXPORT void	Assign (Int16 newValue) override

virtual HO_EXPORT UInt16	AsUInt16 () const override

virtual HO_EXPORT void	Assign (UInt16 newValue) override

virtual HO_EXPORT Int32	AsInt32 () const override

virtual HO_EXPORT void	Assign (Int32 newValue) override

virtual HO_EXPORT UInt32	AsUInt32 () const override

virtual HO_EXPORT void	Assign (UInt32 newValue) override

virtual HO_EXPORT Int64	AsInt64 () const override

virtual HO_EXPORT void	Assign (Int64 newValue) override

virtual HO_EXPORT UInt64	AsUInt64 () const override

virtual HO_EXPORT void	Assign (UInt64 newValue) override

virtual HO_EXPORT float	AsSingle () const override

virtual HO_EXPORT void	Assign (float newValue) override

virtual HO_EXPORT double	AsDouble () const override

virtual HO_EXPORT void	Assign (double newValue) override

virtual HO_EXPORT DateTime	AsDateTime () const override

virtual HO_EXPORT void	Assign (const DateTime &newValue) override

virtual HO_EXPORT TimeSpan	AsTimeSpan () const override

virtual HO_EXPORT void	Assign (const TimeSpan &newValue) override

virtual HO_EXPORT WideString	AsString () const override

virtual HO_EXPORT void	Assign (const WideString &newValue) override

virtual HO_EXPORT Guid	AsGuid () const override

virtual HO_EXPORT void	Assign (const Guid &newValue) override

Public Member Functions inherited from Harlinn::OCI::Bind
	Bind () noexcept

	Bind (const OCI::Statement &statement)

	Bind (const OCI::Statement &statement, UInt32 position)

	Bind (const OCI::Statement &statement, const WideString &name)

void	SimpleBindByPos (UInt32 positon, OraType dataType, void *dataAddress, Int32 dataSize)

void	SimpleBindByName (const WideString &name, OraType dataType, void *dataAddress, Int32 dataSize)

Int16	Indicator () const

void	SetIndicator (Int16 value)

void	SetDBNull ()

void	SetDBNotNull ()

virtual std::vector< Byte >	AsBytes () const

virtual void	Assign (const std::vector< Byte > &newValue)

template<typename T >
T	As () const

template<>
bool	As () const

template<>
SByte	As () const

template<>
Byte	As () const

template<>
Int16	As () const

template<>
UInt16	As () const

template<>
Int32	As () const

template<>
UInt32	As () const

template<>
Int64	As () const

template<>
UInt64	As () const

template<>
Single	As () const

template<>
Double	As () const

template<>
DateTime	As () const

template<>
TimeSpan	As () const

template<>
Guid	As () const

template<>
WideString	As () const

Public Member Functions inherited from Harlinn::OCI::BindBase
	BindBase (const OCI::Statement &statement)

	BindBase (const OCI::Statement &statement, UInt32 position)

	BindBase (const OCI::Statement &statement, const WideString &name)

const OCI::Environment &	Environment () const

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	BindByPos (UInt32 positon, OraType dataType, void dataAddress, Int64 dataSize, Int16 indicators, UInt32 actualLengths=nullptr, UInt16 returnCodes=nullptr, UInt32 plsqlMaxArrayLength=0, UInt32 *plsqlArrayLength=nullptr, UInt32 mode=0)

HO_EXPORT void	BindByName (const WideString &name, OraType dataType, void dataAddress, Int64 dataSize, Int16 indicators, UInt32 actualLengths=nullptr, UInt16 returnCodes=nullptr, UInt32 plsqlMaxArrayLength=0, UInt32 *plsqlArrayLength=nullptr, UInt32 mode=0)

void	OnExecute (UInt32 iters)

constexpr const OCI::Statement &	Statement () const

const OCI::ServiceContext &	ServiceContext () const

UInt32	Position () const

void	SetPosition (UInt32 position)

bool	IsBindByPosition () const

const WideString &	Name () const

WideString	Name ()

void	SetName (const WideString &name)

void	SetCharCount (UInt32 charCount)
	Sets the number of characters in character type data. (OCI_ATTR_CHAR_COUNT)

void	SetMaxCharSize (Int32 maxCharSize)
	Sets the number of characters that an application reserves on the server to store the data being bound.

void	SetMaxDataSize (Int32 maxDataSize)
	Sets the maximum number of bytes allowed in the buffer on the server side to accommodate client-side bind data after character set conversions.

UInt32	CollationId () const
	Retrieves the derived collation of a placeholder expression corresponding to this bind handle in a SQL statement. The value is relevant only for bind variables with character data types.

void	SetCollationId (UInt32 collationId) const
	Sets the derived collation of a placeholder expression corresponding to this bind handle in a SQL statement.The attribute is relevant only for bind variables with character data types.

UInt16	CharacterSet () const
	Retrives the character set ID of the bind handle.

void	SetCharacterSet (UInt16 characterSetId) const
	Sets the character set ID of the bind handle.

OCI::CharacterSetForm	CharacterSetForm () const
	Character set form of the bind handle.The default form is OCI::CharacterSetForm::Implicit.Setting this attribute causes the bind handle to use the database or national character set on the client side.Set this attribute to OCI::CharacterSetForm::NChar for the national character set or OCI::CharacterSetForm::Implicit for the database character set.

void	SetCharacterSetForm (OCI::CharacterSetForm charsetForm)

UInt32	RowsReturned () const
	Returns the number of rows that will be returned in the current iteration when you are in the OUT callback function for binding a DML statement with a RETURNING clause. (OCI_ATTR_ROWS_RETURNED)

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::OraType	ExternalType = OCI::OraType::ORA_OCIString

Protected Member Functions
virtual HO_EXPORT void	Bind (UInt32 positon, UInt32 iters) override

virtual HO_EXPORT void	Bind (const WideString &name, UInt32 iters) override

Protected Member Functions inherited from Harlinn::OCI::BindBase
	BindBase () noexcept

bool	IsPlSQL () const

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 = Bind

Private Attributes
OCIString *	string_

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.

Protected Attributes inherited from Harlinn::OCI::Bind
Int16	indicator_

Detailed Description

StringBind.

Member Typedef Documentation

◆ Base

using Harlinn::OCI::StringBind::Base = Bind

private

◆ BoundType

using Harlinn::OCI::StringBind::BoundType = WideString

Constructor & Destructor Documentation

◆ StringBind() [1/6]

Harlinn::OCI::StringBind::StringBind ( )

inlinenoexcept

◆ StringBind() [2/6]

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

inline

◆ StringBind() [3/6]

Harlinn::OCI::StringBind::StringBind	(	const OCI::Statement &	statement,
		UInt32	position,
		size_t	maximumColumnSize = 0 )

inline

◆ StringBind() [4/6]

Harlinn::OCI::StringBind::StringBind	(	const OCI::Statement &	statement,
		const WideString &	name )

inline

◆ StringBind() [5/6]

Harlinn::OCI::StringBind::StringBind	(	const OCI::Statement &	statement,
		UInt32	position,
		const WideString &	value,
		size_t	maximumColumnSize = 0 )

inline

◆ StringBind() [6/6]

Harlinn::OCI::StringBind::StringBind	(	const OCI::Statement &	statement,
		const WideString &	name,
		const WideString &	value,
		size_t	maximumColumnSize = 0 )

inline

◆ ~StringBind()

Harlinn::OCI::StringBind::~StringBind ( )

virtual

Member Function Documentation

◆ AsBoolean()

bool Harlinn::OCI::StringBind::AsBoolean ( ) const

overridevirtual

Reimplemented from Harlinn::OCI::Bind.

◆ AsByte()

Byte Harlinn::OCI::StringBind::AsByte ( ) const

overridevirtual

Reimplemented from Harlinn::OCI::Bind.

◆ AsDateTime()

DateTime Harlinn::OCI::StringBind::AsDateTime ( ) const

overridevirtual

Reimplemented from Harlinn::OCI::Bind.

◆ AsDouble()

double Harlinn::OCI::StringBind::AsDouble ( ) const

overridevirtual

Reimplemented from Harlinn::OCI::Bind.

◆ AsGuid()

Guid Harlinn::OCI::StringBind::AsGuid ( ) const

overridevirtual

Reimplemented from Harlinn::OCI::Bind.

◆ AsInt16()

short Harlinn::OCI::StringBind::AsInt16 ( ) const

overridevirtual

Reimplemented from Harlinn::OCI::Bind.

◆ AsInt32()

Int32 Harlinn::OCI::StringBind::AsInt32 ( ) const

overridevirtual

Reimplemented from Harlinn::OCI::Bind.

◆ AsInt64()

long long Harlinn::OCI::StringBind::AsInt64 ( ) const

overridevirtual

Reimplemented from Harlinn::OCI::Bind.

◆ AsSByte()

SByte Harlinn::OCI::StringBind::AsSByte ( ) const

overridevirtual

Reimplemented from Harlinn::OCI::Bind.

◆ Assign() [1/15]

void Harlinn::OCI::StringBind::Assign ( bool newValue )

overridevirtual

Reimplemented from Harlinn::OCI::Bind.

◆ Assign() [2/15]

void Harlinn::OCI::StringBind::Assign ( Byte newValue )

overridevirtual

Reimplemented from Harlinn::OCI::Bind.

◆ Assign() [3/15]

void Harlinn::OCI::StringBind::Assign ( const DateTime & newValue )

overridevirtual

Reimplemented from Harlinn::OCI::Bind.

◆ Assign() [4/15]

void Harlinn::OCI::StringBind::Assign ( const Guid & newValue )

overridevirtual

Reimplemented from Harlinn::OCI::Bind.

◆ Assign() [5/15]

void Harlinn::OCI::StringBind::Assign ( const TimeSpan & newValue )

overridevirtual

Reimplemented from Harlinn::OCI::Bind.

◆ Assign() [6/15]

void Harlinn::OCI::StringBind::Assign ( const WideString & newValue )

overridevirtual

Reimplemented from Harlinn::OCI::Bind.

◆ Assign() [7/15]

void Harlinn::OCI::StringBind::Assign ( double newValue )

overridevirtual

Reimplemented from Harlinn::OCI::Bind.

◆ Assign() [8/15]

void Harlinn::OCI::StringBind::Assign ( float newValue )

overridevirtual

Reimplemented from Harlinn::OCI::Bind.

◆ Assign() [9/15]

void Harlinn::OCI::StringBind::Assign ( Int16 newValue )

overridevirtual

Reimplemented from Harlinn::OCI::Bind.

◆ Assign() [10/15]

void Harlinn::OCI::StringBind::Assign ( Int32 newValue )

overridevirtual

Reimplemented from Harlinn::OCI::Bind.

◆ Assign() [11/15]

void Harlinn::OCI::StringBind::Assign ( Int64 newValue )

overridevirtual

Reimplemented from Harlinn::OCI::Bind.

◆ Assign() [12/15]

void Harlinn::OCI::StringBind::Assign ( SByte newValue )

overridevirtual

Reimplemented from Harlinn::OCI::Bind.

◆ Assign() [13/15]

void Harlinn::OCI::StringBind::Assign ( UInt16 newValue )

overridevirtual

Reimplemented from Harlinn::OCI::Bind.

◆ Assign() [14/15]

void Harlinn::OCI::StringBind::Assign ( UInt32 newValue )

overridevirtual

Reimplemented from Harlinn::OCI::Bind.

◆ Assign() [15/15]

void Harlinn::OCI::StringBind::Assign ( UInt64 newValue )

overridevirtual

Reimplemented from Harlinn::OCI::Bind.

◆ AsSingle()

float Harlinn::OCI::StringBind::AsSingle ( ) const

overridevirtual

Reimplemented from Harlinn::OCI::Bind.

◆ AsString()

WideString Harlinn::OCI::StringBind::AsString ( ) const

overridevirtual

Reimplemented from Harlinn::OCI::Bind.

◆ AsTimeSpan()

TimeSpan Harlinn::OCI::StringBind::AsTimeSpan ( ) const

overridevirtual

Reimplemented from Harlinn::OCI::Bind.

◆ AsUInt16()

UInt16 Harlinn::OCI::StringBind::AsUInt16 ( ) const

overridevirtual

Reimplemented from Harlinn::OCI::Bind.

◆ AsUInt32()

UInt32 Harlinn::OCI::StringBind::AsUInt32 ( ) const

overridevirtual

Reimplemented from Harlinn::OCI::Bind.

◆ AsUInt64()

UInt64 Harlinn::OCI::StringBind::AsUInt64 ( ) const

overridevirtual

Reimplemented from Harlinn::OCI::Bind.

◆ Bind() [1/2]

void Harlinn::OCI::StringBind::Bind	(	const WideString &	name,
		UInt32	iters )

overrideprotectedvirtual

Reimplemented from Harlinn::OCI::BindBase.

◆ Bind() [2/2]

void Harlinn::OCI::StringBind::Bind	(	UInt32	positon,
		UInt32	iters )

overrideprotectedvirtual

Reimplemented from Harlinn::OCI::BindBase.

◆ Data()

void * Harlinn::OCI::StringBind::Data ( ) const

overridevirtual

Reimplemented from Harlinn::OCI::Bind.

Member Data Documentation

◆ ExternalType

OCI::OraType Harlinn::OCI::StringBind::ExternalType = OCI::OraType::ORA_OCIString

staticconstexpr

◆ string_

OCIString* Harlinn::OCI::StringBind::string_

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

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Private Types

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Base

◆ BoundType

Constructor & Destructor Documentation

◆ StringBind() [1/6]

◆ StringBind() [2/6]

◆ StringBind() [3/6]

◆ StringBind() [4/6]

◆ StringBind() [5/6]

◆ StringBind() [6/6]

◆ ~StringBind()

Member Function Documentation

◆ AsBoolean()

◆ AsByte()

◆ AsDateTime()

◆ AsDouble()

◆ AsGuid()

◆ AsInt16()

◆ AsInt32()

◆ AsInt64()

◆ AsSByte()

◆ Assign() [1/15]

◆ Assign() [2/15]

◆ Assign() [3/15]

◆ Assign() [4/15]

◆ Assign() [5/15]

◆ Assign() [6/15]

◆ Assign() [7/15]

◆ Assign() [8/15]

◆ Assign() [9/15]

◆ Assign() [10/15]

◆ Assign() [11/15]

◆ Assign() [12/15]

◆ Assign() [13/15]

◆ Assign() [14/15]

◆ Assign() [15/15]

◆ AsSingle()

◆ AsString()

◆ AsTimeSpan()

◆ AsUInt16()

◆ AsUInt32()

◆ AsUInt64()

◆ Bind() [1/2]

◆ Bind() [2/2]

◆ Data()

Member Data Documentation

◆ ExternalType

◆ string_