ocilib::Reference Class Reference

Object identifying the SQL data type REF. More...

#include <ocilib.hpp>

Inherits ocilib::HandleHolder< OCI_Ref * >.

Public Member Functions
	Reference (const TypeInfo &typeInfo)
	Parametrized constructor. More...
TypeInfo	GetTypeInfo () const
	Return the TypeInfo object describing the referenced object.
Object	GetObject () const
	Returns the object pointed by the reference. More...
bool	IsReferenceNull () const
	Check if the reference points to an object or not.
void	SetReferenceNull ()
	Nullify the given Ref handle. More...
Reference	Clone () const
	Clone the current instance to a new one performing deep copy.
ostring	ToString () const
	return a string representation of the current reference
	operator ostring () const
	Convenient operator returning a string representation of the current reference. More...

Detailed Description

Object identifying the SQL data type REF.

This class wraps the OCILIB object handle OCI_Ref and its related methods

Definition at line 4310 of file ocilib.hpp.

Constructor & Destructor Documentation

ocilib::Reference::Reference ( const TypeInfo &  typeInfo )

inline

Parametrized constructor.

Parameters

typeInfo

- type info descriptor

Definition at line 2974 of file ocilib_impl.hpp.

References ocilib::Check(), ocilib::TypeInfo::GetConnection(), OCI_RefCreate(), and OCI_RefFree().

Member Function Documentation

Object ocilib::Reference::GetObject ( ) const

inline

Returns the object pointed by the reference.

Returns

The object may bu null is the current reference value is null

Definition at line 2990 of file ocilib_impl.hpp.

References ocilib::Check(), and OCI_RefGetObject().

void ocilib::Reference::SetReferenceNull ( )

inline

Nullify the given Ref handle.

Note

this call clears the reference to object pointed by the reference object.

Definition at line 3009 of file ocilib_impl.hpp.

References ocilib::Check(), and OCI_RefSetNull().

ocilib::Reference::operator ostring ( ) const

inline

Convenient operator returning a string representation of the current reference.

Note

It calls ToString()

Definition at line 3025 of file ocilib_impl.hpp.