#include <HOCI.h>

Inheritance diagram for Harlinn::OCI::Session:

Collaboration diagram for Harlinn::OCI::Session:

Public Member Functions
constexpr	Session () noexcept

	Session (const OCI::Environment &environment, void *ocisession, bool ownsHandle)
	Constructs a new Session object.

constexpr	Session (const Session &other)=delete

constexpr	Session (Session &&other) noexcept

constexpr Session &	operator= (const Session &other)=delete

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

constexpr void	swap (Session &other) noexcept

const 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.

template<WideStringLike StringT = WideString>
StringT	UserName () const

template<WideStringLike StringT>
void	SetUserName (const StringT &userName) const

void	SetUserName (const wchar_t *userName, size_t userNameLength) const

template<WideStringLike StringT>
void	SetPassword (const StringT &password) const

void	SetPassword (const wchar_t *password, size_t passwordLength) 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 Attributes
static constexpr OCI::HandleType	OCIHandleType = OCI::HandleType::Session

Private Types
using	Base = HandleBase

Private Attributes
const Environment *	environment_

ErrorHandle	error_

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

Session.

Member Typedef Documentation

◆ Base

using Harlinn::OCI::Session::Base = HandleBase

private

Constructor & Destructor Documentation

◆ Session() [1/4]

Harlinn::OCI::Session::Session ( )

inlineconstexprnoexcept

◆ Session() [2/4]

Harlinn::OCI::Session::Session	(	const OCI::Environment &	environment,
		void *	ocisession,
		bool	ownsHandle )

inline

Constructs a new Session object.

Parameters

environment	A reference to the environment used to create the session handle
handle	The handle wrapped by this object.
ownsHandle	Set to true if the new object will take owneship of the handle value

◆ Session() [3/4]

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

constexprdelete

◆ Session() [4/4]

Harlinn::OCI::Session::Session ( Session && other )

inlineconstexprnoexcept

Member Function Documentation

◆ Environment()

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

inline

◆ Error()

const OCI::ErrorHandle & Harlinn::OCI::Session::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]

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

constexprdelete

◆ operator=() [2/2]

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

inlineconstexprnoexcept

◆ SetPassword() [1/2]

template<WideStringLike StringT>

void Harlinn::OCI::Session::SetPassword ( const StringT & password ) const

inline

◆ SetPassword() [2/2]

void Harlinn::OCI::Session::SetPassword	(	const wchar_t *	password,
		size_t	passwordLength ) const

inline

◆ SetUserName() [1/2]

template<WideStringLike StringT>

void Harlinn::OCI::Session::SetUserName ( const StringT & userName ) const

inline

◆ SetUserName() [2/2]

void Harlinn::OCI::Session::SetUserName	(	const wchar_t *	userName,
		size_t	userNameLength ) const

inline

◆ swap()

void Harlinn::OCI::Session::swap ( Session & other )

inlineconstexprnoexcept

◆ UserName()

template<WideStringLike StringT = WideString>

StringT Harlinn::OCI::Session::UserName ( ) const

inline

Member Data Documentation

◆ environment_

const Environment* Harlinn::OCI::Session::environment_

private

◆ error_

ErrorHandle Harlinn::OCI::Session::error_

private

◆ OCIHandleType

OCI::HandleType Harlinn::OCI::Session::OCIHandleType = OCI::HandleType::Session

staticconstexpr

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

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

Public Member Functions

Static Public Attributes

Private Types

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Base

Constructor & Destructor Documentation

◆ Session() [1/4]

◆ Session() [2/4]

◆ Session() [3/4]

◆ Session() [4/4]

Member Function Documentation

◆ Environment()

◆ Error()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ SetPassword() [1/2]

◆ SetPassword() [2/2]

◆ SetUserName() [1/2]

◆ SetUserName() [2/2]

◆ swap()

◆ UserName()

Member Data Documentation

◆ environment_

◆ error_

◆ OCIHandleType