OCILIB (C and C++ Driver for Oracle)
4.6.3
|
OCILIB implements Oracle Named types (user types and built-in types) through the OCI_Object type.
OTT and C structures are not required to use objects in OCILIB.
In order to manipulate objects attributes, OCILIB proposes a set of functions to get/set properties for various supported types.
Objects can be:
References (Oracle type REF) are identifiers (smart pointers) to objects and are implemented in OCILIB with the type OCI_Ref.
OCILIB implements Oracle REFs as strong typed Reference (underlying OCI REFs are weaker in terms of typing). It means it's mandatory to provide type information to:
Functions | |
OCI_EXPORT OCI_Object *OCI_API | OCI_ObjectCreate (OCI_Connection *con, OCI_TypeInfo *typinf) |
Create a local object instance. More... | |
OCI_EXPORT boolean OCI_API | OCI_ObjectFree (OCI_Object *obj) |
Free a local object. More... | |
OCI_EXPORT OCI_Object **OCI_API | OCI_ObjectArrayCreate (OCI_Connection *con, OCI_TypeInfo *typinf, unsigned int nbelem) |
Create an array of Object objects. More... | |
OCI_EXPORT boolean OCI_API | OCI_ObjectArrayFree (OCI_Object **objs) |
Free an array of Object objects. More... | |
OCI_EXPORT boolean OCI_API | OCI_ObjectAssign (OCI_Object *obj, OCI_Object *obj_src) |
Assign an object to another one. More... | |
OCI_EXPORT unsigned int OCI_API | OCI_ObjectGetType (OCI_Object *obj) |
Return the type of an object instance. More... | |
OCI_EXPORT boolean OCI_API | OCI_ObjectGetSelfRef (OCI_Object *obj, OCI_Ref *ref) |
Retrieve an Oracle Ref handle from an object and assign it to the given OCILIB OCI_Ref handle. More... | |
OCI_EXPORT OCI_TypeInfo *OCI_API | OCI_ObjectGetTypeInfo (OCI_Object *obj) |
Return the type info object associated to the object. More... | |
OCI_EXPORT boolean OCI_API | OCI_ObjectGetBoolean (OCI_Object *obj, const otext *attr) |
Return the boolean value of the given object attribute (ONLY for PL/SQL records) More... | |
OCI_EXPORT OCI_Number *OCI_API | OCI_ObjectGetNumber (OCI_Object *obj, const otext *attr) |
Return the number value of the given object attribute. More... | |
OCI_EXPORT short OCI_API | OCI_ObjectGetShort (OCI_Object *obj, const otext *attr) |
Return the short value of the given object attribute. More... | |
OCI_EXPORT unsigned short OCI_API | OCI_ObjectGetUnsignedShort (OCI_Object *obj, const otext *attr) |
Return the unsigned short value of the given object attribute. More... | |
OCI_EXPORT int OCI_API | OCI_ObjectGetInt (OCI_Object *obj, const otext *attr) |
Return the integer value of the given object attribute. More... | |
OCI_EXPORT unsigned int OCI_API | OCI_ObjectGetUnsignedInt (OCI_Object *obj, const otext *attr) |
Return the unsigned integer value of the given object attribute. More... | |
OCI_EXPORT big_int OCI_API | OCI_ObjectGetBigInt (OCI_Object *obj, const otext *attr) |
Return the big integer value of the given object attribute. More... | |
OCI_EXPORT big_uint OCI_API | OCI_ObjectGetUnsignedBigInt (OCI_Object *obj, const otext *attr) |
Return the unsigned big integer value of the given object attribute. More... | |
OCI_EXPORT double OCI_API | OCI_ObjectGetDouble (OCI_Object *obj, const otext *attr) |
Return the double value of the given object attribute. More... | |
OCI_EXPORT float OCI_API | OCI_ObjectGetFloat (OCI_Object *obj, const otext *attr) |
Return the float value of the given object attribute. More... | |
OCI_EXPORT const otext *OCI_API | OCI_ObjectGetString (OCI_Object *obj, const otext *attr) |
Return the string value of the given object attribute. More... | |
OCI_EXPORT int OCI_API | OCI_ObjectGetRaw (OCI_Object *obj, const otext *attr, void *value, unsigned int len) |
Return the raw attribute value of the given object attribute into the given buffer. More... | |
OCI_EXPORT unsigned int OCI_API | OCI_ObjectGetRawSize (OCI_Object *obj, const otext *attr) |
Return the raw attribute value size of the given object attribute into the given buffer. More... | |
OCI_EXPORT OCI_Date *OCI_API | OCI_ObjectGetDate (OCI_Object *obj, const otext *attr) |
Return the date value of the given object attribute. More... | |
OCI_EXPORT OCI_Timestamp *OCI_API | OCI_ObjectGetTimestamp (OCI_Object *obj, const otext *attr) |
Return the timestamp value of the given object attribute. More... | |
OCI_EXPORT OCI_Interval *OCI_API | OCI_ObjectGetInterval (OCI_Object *obj, const otext *attr) |
Return the interval value of the given object attribute. More... | |
OCI_EXPORT OCI_Coll *OCI_API | OCI_ObjectGetColl (OCI_Object *obj, const otext *attr) |
Return the collection value of the given object attribute. More... | |
OCI_EXPORT OCI_Ref *OCI_API | OCI_ObjectGetRef (OCI_Object *obj, const otext *attr) |
Return the Ref value of the given object attribute. More... | |
OCI_EXPORT OCI_Object *OCI_API | OCI_ObjectGetObject (OCI_Object *obj, const otext *attr) |
Return the object value of the given object attribute. More... | |
OCI_EXPORT OCI_Lob *OCI_API | OCI_ObjectGetLob (OCI_Object *obj, const otext *attr) |
Return the lob value of the given object attribute. More... | |
OCI_EXPORT OCI_File *OCI_API | OCI_ObjectGetFile (OCI_Object *obj, const otext *attr) |
Return the file value of the given object attribute. More... | |
OCI_EXPORT boolean OCI_API | OCI_ObjectSetBoolean (OCI_Object *obj, const otext *attr, boolean value) |
Set an object attribute of type boolean (ONLY for PL/SQL records) More... | |
OCI_EXPORT boolean OCI_API | OCI_ObjectSetNumber (OCI_Object *obj, const otext *attr, OCI_Number *value) |
Set an object attribute of type number. More... | |
OCI_EXPORT boolean OCI_API | OCI_ObjectSetShort (OCI_Object *obj, const otext *attr, short value) |
Set an object attribute of type short. More... | |
OCI_EXPORT boolean OCI_API | OCI_ObjectSetUnsignedShort (OCI_Object *obj, const otext *attr, unsigned short value) |
Set an object attribute of type unsigned short. More... | |
OCI_EXPORT boolean OCI_API | OCI_ObjectSetInt (OCI_Object *obj, const otext *attr, int value) |
Set an object attribute of type int. More... | |
OCI_EXPORT boolean OCI_API | OCI_ObjectSetUnsignedInt (OCI_Object *obj, const otext *attr, unsigned int value) |
Set an object attribute of type unsigned int. More... | |
OCI_EXPORT boolean OCI_API | OCI_ObjectSetBigInt (OCI_Object *obj, const otext *attr, big_int value) |
Set an object attribute of type big int. More... | |
OCI_EXPORT boolean OCI_API | OCI_ObjectSetUnsignedBigInt (OCI_Object *obj, const otext *attr, big_uint value) |
Set an object attribute of type unsigned big int. More... | |
OCI_EXPORT boolean OCI_API | OCI_ObjectSetDouble (OCI_Object *obj, const otext *attr, double value) |
Set an object attribute of type double. More... | |
OCI_EXPORT boolean OCI_API | OCI_ObjectSetFloat (OCI_Object *obj, const otext *attr, float value) |
Set an object attribute of type float. More... | |
OCI_EXPORT boolean OCI_API | OCI_ObjectSetString (OCI_Object *obj, const otext *attr, const otext *value) |
Set an object attribute of type string. More... | |
OCI_EXPORT boolean OCI_API | OCI_ObjectSetRaw (OCI_Object *obj, const otext *attr, void *value, unsigned int len) |
Set an object attribute of type RAW. More... | |
OCI_EXPORT boolean OCI_API | OCI_ObjectSetDate (OCI_Object *obj, const otext *attr, OCI_Date *value) |
Set an object attribute of type Date. More... | |
OCI_EXPORT boolean OCI_API | OCI_ObjectSetTimestamp (OCI_Object *obj, const otext *attr, OCI_Timestamp *value) |
Set an object attribute of type Timestamp. More... | |
OCI_EXPORT boolean OCI_API | OCI_ObjectSetInterval (OCI_Object *obj, const otext *attr, OCI_Interval *value) |
Set an object attribute of type Interval. More... | |
OCI_EXPORT boolean OCI_API | OCI_ObjectSetColl (OCI_Object *obj, const otext *attr, OCI_Coll *value) |
Set an object attribute of type Collection. More... | |
OCI_EXPORT boolean OCI_API | OCI_ObjectSetObject (OCI_Object *obj, const otext *attr, OCI_Object *value) |
Set an object attribute of type Object. More... | |
OCI_EXPORT boolean OCI_API | OCI_ObjectSetLob (OCI_Object *obj, const otext *attr, OCI_Lob *value) |
Set an object attribute of type Lob. More... | |
OCI_EXPORT boolean OCI_API | OCI_ObjectSetFile (OCI_Object *obj, const otext *attr, OCI_File *value) |
Set an object attribute of type File. More... | |
OCI_EXPORT boolean OCI_API | OCI_ObjectSetRef (OCI_Object *obj, const otext *attr, OCI_Ref *value) |
Set an object attribute of type Ref. More... | |
OCI_EXPORT boolean OCI_API | OCI_ObjectIsNull (OCI_Object *obj, const otext *attr) |
Check if an object attribute is null. More... | |
OCI_EXPORT boolean OCI_API | OCI_ObjectSetNull (OCI_Object *obj, const otext *attr) |
Set an object attribute to null. More... | |
OCI_EXPORT boolean OCI_API | OCI_ObjectGetStruct (OCI_Object *obj, void **pp_struct, void **pp_ind) |
Retrieve the underlying C (OTT/OCI style) structure of an OCI_Object handle. More... | |
OCI_EXPORT boolean OCI_API | OCI_ObjectToText (OCI_Object *obj, unsigned int *size, otext *str) |
Convert an object handle value to a string. More... | |
OCI_EXPORT OCI_Ref *OCI_API | OCI_RefCreate (OCI_Connection *con, OCI_TypeInfo *typinf) |
Create a local Ref instance. More... | |
OCI_EXPORT boolean OCI_API | OCI_RefFree (OCI_Ref *ref) |
Free a local Ref. More... | |
OCI_EXPORT OCI_Ref **OCI_API | OCI_RefArrayCreate (OCI_Connection *con, OCI_TypeInfo *typinf, unsigned int nbelem) |
Create an array of Ref object. More... | |
OCI_EXPORT boolean OCI_API | OCI_RefArrayFree (OCI_Ref **refs) |
Free an array of Ref objects. More... | |
OCI_EXPORT boolean OCI_API | OCI_RefAssign (OCI_Ref *ref, OCI_Ref *ref_src) |
Assign a Ref to another one. More... | |
OCI_EXPORT OCI_TypeInfo *OCI_API | OCI_RefGetTypeInfo (OCI_Ref *ref) |
Return the type info object associated to the Ref. More... | |
OCI_EXPORT OCI_Object *OCI_API | OCI_RefGetObject (OCI_Ref *ref) |
Returns the object pointed by the Ref handle. More... | |
OCI_EXPORT boolean OCI_API | OCI_RefIsNull (OCI_Ref *ref) |
Check if the Ref points to an object or not. More... | |
OCI_EXPORT boolean OCI_API | OCI_RefSetNull (OCI_Ref *ref) |
Nullify the given Ref handle. More... | |
OCI_EXPORT unsigned int OCI_API | OCI_RefGetHexSize (OCI_Ref *ref) |
Returns the size of the hex representation of the given Ref handle. More... | |
OCI_EXPORT boolean OCI_API | OCI_RefToText (OCI_Ref *ref, unsigned int size, otext *str) |
Converts a Ref handle value to a hexadecimal string. More... | |
OCI_EXPORT OCI_Object* OCI_API OCI_ObjectCreate | ( | OCI_Connection * | con, |
OCI_TypeInfo * | typinf | ||
) |
#include <ocilib.h>
Create a local object instance.
con | - Connection handle |
typinf | - Object type (type info handle) |
Referenced by ocilib::Object::Object().
OCI_EXPORT boolean OCI_API OCI_ObjectFree | ( | OCI_Object * | obj | ) |
#include <ocilib.h>
Free a local object.
obj | - Object handle |
Referenced by ocilib::Object::Object().
OCI_EXPORT OCI_Object** OCI_API OCI_ObjectArrayCreate | ( | OCI_Connection * | con, |
OCI_TypeInfo * | typinf, | ||
unsigned int | nbelem | ||
) |
#include <ocilib.h>
Create an array of Object objects.
con | - Connection handle |
typinf | - Object type (type info handle) |
nbelem | - number of elements in the array |
OCI_EXPORT boolean OCI_API OCI_ObjectArrayFree | ( | OCI_Object ** | objs | ) |
#include <ocilib.h>
Free an array of Object objects.
objs | - Array of Object objects |
OCI_EXPORT boolean OCI_API OCI_ObjectAssign | ( | OCI_Object * | obj, |
OCI_Object * | obj_src | ||
) |
#include <ocilib.h>
Assign an object to another one.
obj | - Destination Object handle |
obj_src | - Source Object handle |
Referenced by ocilib::Object::Clone().
OCI_EXPORT unsigned int OCI_API OCI_ObjectGetType | ( | OCI_Object * | obj | ) |
#include <ocilib.h>
Return the type of an object instance.
obj | - Object handle |
Referenced by ocilib::Object::GetType().
OCI_EXPORT boolean OCI_API OCI_ObjectGetSelfRef | ( | OCI_Object * | obj, |
OCI_Ref * | ref | ||
) |
#include <ocilib.h>
Retrieve an Oracle Ref handle from an object and assign it to the given OCILIB OCI_Ref handle.
obj | - Object handle |
ref | - Ref handle |
Referenced by ocilib::Object::GetReference().
OCI_EXPORT OCI_TypeInfo* OCI_API OCI_ObjectGetTypeInfo | ( | OCI_Object * | obj | ) |
#include <ocilib.h>
Return the type info object associated to the object.
obj | - Object handle |
Referenced by ocilib::Object::GetTypeInfo().
OCI_EXPORT boolean OCI_API OCI_ObjectGetBoolean | ( | OCI_Object * | obj, |
const otext * | attr | ||
) |
#include <ocilib.h>
Return the boolean value of the given object attribute (ONLY for PL/SQL records)
obj | - Object handle |
attr | - Attribute name |
Referenced by ocilib::Object::GetType().
OCI_EXPORT OCI_Number* OCI_API OCI_ObjectGetNumber | ( | OCI_Object * | obj, |
const otext * | attr | ||
) |
#include <ocilib.h>
Return the number value of the given object attribute.
obj | - Object handle |
attr | - Attribute name |
Referenced by ocilib::Object::GetType().
OCI_EXPORT short OCI_API OCI_ObjectGetShort | ( | OCI_Object * | obj, |
const otext * | attr | ||
) |
#include <ocilib.h>
Return the short value of the given object attribute.
obj | - Object handle |
attr | - Attribute name |
Referenced by ocilib::Object::GetType().
OCI_EXPORT unsigned short OCI_API OCI_ObjectGetUnsignedShort | ( | OCI_Object * | obj, |
const otext * | attr | ||
) |
#include <ocilib.h>
Return the unsigned short value of the given object attribute.
obj | - Object handle |
attr | - Attribute name |
Referenced by ocilib::Object::GetType().
OCI_EXPORT int OCI_API OCI_ObjectGetInt | ( | OCI_Object * | obj, |
const otext * | attr | ||
) |
#include <ocilib.h>
Return the integer value of the given object attribute.
obj | - Object handle |
attr | - Attribute name |
Referenced by ocilib::Object::GetType().
OCI_EXPORT unsigned int OCI_API OCI_ObjectGetUnsignedInt | ( | OCI_Object * | obj, |
const otext * | attr | ||
) |
#include <ocilib.h>
Return the unsigned integer value of the given object attribute.
obj | - Object handle |
attr | - Attribute name |
Referenced by ocilib::Object::GetType().
OCI_EXPORT big_int OCI_API OCI_ObjectGetBigInt | ( | OCI_Object * | obj, |
const otext * | attr | ||
) |
#include <ocilib.h>
Return the big integer value of the given object attribute.
obj | - Object handle |
attr | - Attribute name |
Referenced by ocilib::Object::GetType().
OCI_EXPORT big_uint OCI_API OCI_ObjectGetUnsignedBigInt | ( | OCI_Object * | obj, |
const otext * | attr | ||
) |
#include <ocilib.h>
Return the unsigned big integer value of the given object attribute.
obj | - Object handle |
attr | - Attribute name |
Referenced by ocilib::Object::GetType().
OCI_EXPORT double OCI_API OCI_ObjectGetDouble | ( | OCI_Object * | obj, |
const otext * | attr | ||
) |
#include <ocilib.h>
Return the double value of the given object attribute.
obj | - Object handle |
attr | - Attribute name |
Referenced by ocilib::Object::GetType().
OCI_EXPORT float OCI_API OCI_ObjectGetFloat | ( | OCI_Object * | obj, |
const otext * | attr | ||
) |
#include <ocilib.h>
Return the float value of the given object attribute.
obj | - Object handle |
attr | - Attribute name |
Referenced by ocilib::Object::GetType().
OCI_EXPORT const otext* OCI_API OCI_ObjectGetString | ( | OCI_Object * | obj, |
const otext * | attr | ||
) |
#include <ocilib.h>
Return the string value of the given object attribute.
obj | - Object handle |
attr | - Attribute name |
Referenced by ocilib::Object::GetType().
OCI_EXPORT int OCI_API OCI_ObjectGetRaw | ( | OCI_Object * | obj, |
const otext * | attr, | ||
void * | value, | ||
unsigned int | len | ||
) |
#include <ocilib.h>
Return the raw attribute value of the given object attribute into the given buffer.
obj | - Object handle |
attr | - Attribute name |
value | - Destination buffer |
len | - Max size to write into buffer |
Referenced by ocilib::Object::GetType().
OCI_EXPORT unsigned int OCI_API OCI_ObjectGetRawSize | ( | OCI_Object * | obj, |
const otext * | attr | ||
) |
#include <ocilib.h>
Return the raw attribute value size of the given object attribute into the given buffer.
obj | - Object handle |
attr | - Attribute name |
Referenced by ocilib::Object::GetType().
OCI_EXPORT OCI_Date* OCI_API OCI_ObjectGetDate | ( | OCI_Object * | obj, |
const otext * | attr | ||
) |
#include <ocilib.h>
Return the date value of the given object attribute.
obj | - Object handle |
attr | - Attribute name |
Referenced by ocilib::Object::GetType().
OCI_EXPORT OCI_Timestamp* OCI_API OCI_ObjectGetTimestamp | ( | OCI_Object * | obj, |
const otext * | attr | ||
) |
#include <ocilib.h>
Return the timestamp value of the given object attribute.
obj | - Object handle |
attr | - Attribute name |
Referenced by ocilib::Object::GetType().
OCI_EXPORT OCI_Interval* OCI_API OCI_ObjectGetInterval | ( | OCI_Object * | obj, |
const otext * | attr | ||
) |
#include <ocilib.h>
Return the interval value of the given object attribute.
obj | - Object handle |
attr | - Attribute name |
Referenced by ocilib::Object::GetType().
OCI_EXPORT OCI_Coll* OCI_API OCI_ObjectGetColl | ( | OCI_Object * | obj, |
const otext * | attr | ||
) |
#include <ocilib.h>
Return the collection value of the given object attribute.
obj | - Object handle |
attr | - Attribute name |
Referenced by ocilib::Object::Get().
OCI_EXPORT OCI_Ref* OCI_API OCI_ObjectGetRef | ( | OCI_Object * | obj, |
const otext * | attr | ||
) |
#include <ocilib.h>
Return the Ref value of the given object attribute.
obj | - Object handle |
attr | - Attribute name |
Referenced by ocilib::Object::GetType().
OCI_EXPORT OCI_Object* OCI_API OCI_ObjectGetObject | ( | OCI_Object * | obj, |
const otext * | attr | ||
) |
#include <ocilib.h>
Return the object value of the given object attribute.
obj | - Object handle |
attr | - Attribute name |
Referenced by ocilib::Object::GetType().
OCI_EXPORT OCI_Lob* OCI_API OCI_ObjectGetLob | ( | OCI_Object * | obj, |
const otext * | attr | ||
) |
#include <ocilib.h>
Return the lob value of the given object attribute.
obj | - Object handle |
attr | - Attribute name |
Referenced by ocilib::Object::GetType().
OCI_EXPORT OCI_File* OCI_API OCI_ObjectGetFile | ( | OCI_Object * | obj, |
const otext * | attr | ||
) |
#include <ocilib.h>
Return the file value of the given object attribute.
obj | - Object handle |
attr | - Attribute name |
Referenced by ocilib::Object::GetType().
OCI_EXPORT boolean OCI_API OCI_ObjectSetBoolean | ( | OCI_Object * | obj, |
const otext * | attr, | ||
boolean | value | ||
) |
#include <ocilib.h>
Set an object attribute of type boolean (ONLY for PL/SQL records)
obj | - Object handle |
attr | - Attribute name |
value | - boolean value |
Referenced by ocilib::Object::Get().
OCI_EXPORT boolean OCI_API OCI_ObjectSetNumber | ( | OCI_Object * | obj, |
const otext * | attr, | ||
OCI_Number * | value | ||
) |
#include <ocilib.h>
Set an object attribute of type number.
obj | - Object handle |
attr | - Attribute name |
value | - number value |
Referenced by ocilib::Object::Get().
OCI_EXPORT boolean OCI_API OCI_ObjectSetShort | ( | OCI_Object * | obj, |
const otext * | attr, | ||
short | value | ||
) |
#include <ocilib.h>
Set an object attribute of type short.
obj | - Object handle |
attr | - Attribute name |
value | - Short value |
Referenced by ocilib::Object::Get().
OCI_EXPORT boolean OCI_API OCI_ObjectSetUnsignedShort | ( | OCI_Object * | obj, |
const otext * | attr, | ||
unsigned short | value | ||
) |
#include <ocilib.h>
Set an object attribute of type unsigned short.
obj | - Object handle |
attr | - Attribute name |
value | - Unsigned short value |
Referenced by ocilib::Object::Get().
OCI_EXPORT boolean OCI_API OCI_ObjectSetInt | ( | OCI_Object * | obj, |
const otext * | attr, | ||
int | value | ||
) |
#include <ocilib.h>
Set an object attribute of type int.
obj | - Object handle |
attr | - Attribute name |
value | - Int value |
Referenced by ocilib::Object::Get().
OCI_EXPORT boolean OCI_API OCI_ObjectSetUnsignedInt | ( | OCI_Object * | obj, |
const otext * | attr, | ||
unsigned int | value | ||
) |
#include <ocilib.h>
Set an object attribute of type unsigned int.
obj | - Object handle |
attr | - Attribute name |
value | - Unsigned int value |
Referenced by ocilib::Object::Get().
OCI_EXPORT boolean OCI_API OCI_ObjectSetBigInt | ( | OCI_Object * | obj, |
const otext * | attr, | ||
big_int | value | ||
) |
#include <ocilib.h>
Set an object attribute of type big int.
obj | - Object handle |
attr | - Attribute name |
value | - Big int value |
Referenced by ocilib::Object::Get().
OCI_EXPORT boolean OCI_API OCI_ObjectSetUnsignedBigInt | ( | OCI_Object * | obj, |
const otext * | attr, | ||
big_uint | value | ||
) |
#include <ocilib.h>
Set an object attribute of type unsigned big int.
obj | - Object handle |
attr | - Attribute name |
value | - Unsigned big int value |
Referenced by ocilib::Object::Get().
OCI_EXPORT boolean OCI_API OCI_ObjectSetDouble | ( | OCI_Object * | obj, |
const otext * | attr, | ||
double | value | ||
) |
#include <ocilib.h>
Set an object attribute of type double.
obj | - Object handle |
attr | - Attribute name |
value | - Double value |
Referenced by ocilib::Object::Get().
OCI_EXPORT boolean OCI_API OCI_ObjectSetFloat | ( | OCI_Object * | obj, |
const otext * | attr, | ||
float | value | ||
) |
#include <ocilib.h>
Set an object attribute of type float.
obj | - Object handle |
attr | - Attribute name |
value | - Float value |
Referenced by ocilib::Object::Get().
OCI_EXPORT boolean OCI_API OCI_ObjectSetString | ( | OCI_Object * | obj, |
const otext * | attr, | ||
const otext * | value | ||
) |
#include <ocilib.h>
Set an object attribute of type string.
obj | - Object handle |
attr | - Attribute name |
value | - String value |
Referenced by ocilib::Object::Get().
OCI_EXPORT boolean OCI_API OCI_ObjectSetRaw | ( | OCI_Object * | obj, |
const otext * | attr, | ||
void * | value, | ||
unsigned int | len | ||
) |
#include <ocilib.h>
Set an object attribute of type RAW.
obj | - Object handle |
attr | - Attribute name |
value | - Raw value |
len | - Size of the raw value |
Referenced by ocilib::Object::Get().
OCI_EXPORT boolean OCI_API OCI_ObjectSetDate | ( | OCI_Object * | obj, |
const otext * | attr, | ||
OCI_Date * | value | ||
) |
#include <ocilib.h>
Set an object attribute of type Date.
obj | - Object handle |
attr | - Attribute name |
value | - Date Handle |
Referenced by ocilib::Object::Get().
OCI_EXPORT boolean OCI_API OCI_ObjectSetTimestamp | ( | OCI_Object * | obj, |
const otext * | attr, | ||
OCI_Timestamp * | value | ||
) |
#include <ocilib.h>
Set an object attribute of type Timestamp.
obj | - Object handle |
attr | - Attribute name |
value | - Timestamp Handle |
Referenced by ocilib::Object::Get().
OCI_EXPORT boolean OCI_API OCI_ObjectSetInterval | ( | OCI_Object * | obj, |
const otext * | attr, | ||
OCI_Interval * | value | ||
) |
#include <ocilib.h>
Set an object attribute of type Interval.
obj | - Object handle |
attr | - Attribute name |
value | - Interval Handle |
Referenced by ocilib::Object::Get().
OCI_EXPORT boolean OCI_API OCI_ObjectSetColl | ( | OCI_Object * | obj, |
const otext * | attr, | ||
OCI_Coll * | value | ||
) |
#include <ocilib.h>
Set an object attribute of type Collection.
obj | - Object handle |
attr | - Attribute name |
value | - Collection Handle |
Referenced by ocilib::Object::Set().
OCI_EXPORT boolean OCI_API OCI_ObjectSetObject | ( | OCI_Object * | obj, |
const otext * | attr, | ||
OCI_Object * | value | ||
) |
#include <ocilib.h>
Set an object attribute of type Object.
obj | - Object handle |
attr | - Attribute name |
value | - Object Handle |
Referenced by ocilib::Object::Get().
OCI_EXPORT boolean OCI_API OCI_ObjectSetLob | ( | OCI_Object * | obj, |
const otext * | attr, | ||
OCI_Lob * | value | ||
) |
#include <ocilib.h>
Set an object attribute of type Lob.
obj | - Object handle |
attr | - Attribute name |
value | - Lob Handle |
Referenced by ocilib::Object::Get().
OCI_EXPORT boolean OCI_API OCI_ObjectSetFile | ( | OCI_Object * | obj, |
const otext * | attr, | ||
OCI_File * | value | ||
) |
#include <ocilib.h>
Set an object attribute of type File.
obj | - Object handle |
attr | - Attribute name |
value | - File Handle |
Referenced by ocilib::Object::Get().
OCI_EXPORT boolean OCI_API OCI_ObjectSetRef | ( | OCI_Object * | obj, |
const otext * | attr, | ||
OCI_Ref * | value | ||
) |
#include <ocilib.h>
Set an object attribute of type Ref.
obj | - Object handle |
attr | - Attribute name |
value | - Ref Handle |
Referenced by ocilib::Object::Get().
OCI_EXPORT boolean OCI_API OCI_ObjectIsNull | ( | OCI_Object * | obj, |
const otext * | attr | ||
) |
#include <ocilib.h>
Check if an object attribute is null.
obj | - Object handle |
attr | - Attribute name |
Referenced by ocilib::Object::IsAttributeNull().
OCI_EXPORT boolean OCI_API OCI_ObjectSetNull | ( | OCI_Object * | obj, |
const otext * | attr | ||
) |
#include <ocilib.h>
Set an object attribute to null.
obj | - Object handle |
attr | - Attribute name |
Referenced by ocilib::Object::SetAttributeNull().
OCI_EXPORT boolean OCI_API OCI_ObjectGetStruct | ( | OCI_Object * | obj, |
void ** | pp_struct, | ||
void ** | pp_ind | ||
) |
#include <ocilib.h>
Retrieve the underlying C (OTT/OCI style) structure of an OCI_Object handle.
obj | - Object handle |
pp_struct | - Address of a pointer that retrieve the C structure of data |
pp_ind | - Address of a pointer that retrieve the C structure of indicators |
OCI_EXPORT boolean OCI_API OCI_ObjectToText | ( | OCI_Object * | obj, |
unsigned int * | size, | ||
otext * | str | ||
) |
#include <ocilib.h>
Convert an object handle value to a string.
obj | - Object handle |
size | - Destination string length pointer in characters |
str | - Destination string |
Referenced by ocilib::Object::ToString().
OCI_EXPORT OCI_Ref* OCI_API OCI_RefCreate | ( | OCI_Connection * | con, |
OCI_TypeInfo * | typinf | ||
) |
#include <ocilib.h>
Create a local Ref instance.
con | - Connection handle |
typinf | - Ref type |
Referenced by ocilib::Object::GetReference(), and ocilib::Reference::Reference().
OCI_EXPORT boolean OCI_API OCI_RefFree | ( | OCI_Ref * | ref | ) |
#include <ocilib.h>
Free a local Ref.
ref | - Ref handle |
Referenced by ocilib::Reference::Reference().
OCI_EXPORT OCI_Ref** OCI_API OCI_RefArrayCreate | ( | OCI_Connection * | con, |
OCI_TypeInfo * | typinf, | ||
unsigned int | nbelem | ||
) |
#include <ocilib.h>
Create an array of Ref object.
con | - Connection handle |
typinf | - Object type (type info handle) |
nbelem | - number of elements in the array |
OCI_EXPORT boolean OCI_API OCI_RefArrayFree | ( | OCI_Ref ** | refs | ) |
#include <ocilib.h>
Free an array of Ref objects.
refs | - Array of Ref objects |
#include <ocilib.h>
Assign a Ref to another one.
ref | - Destination Ref handle |
ref_src | - Source Ref handle |
Referenced by ocilib::Reference::Clone().
OCI_EXPORT OCI_TypeInfo* OCI_API OCI_RefGetTypeInfo | ( | OCI_Ref * | ref | ) |
#include <ocilib.h>
Return the type info object associated to the Ref.
ref | - Ref handle |
Referenced by ocilib::Reference::GetTypeInfo().
OCI_EXPORT OCI_Object* OCI_API OCI_RefGetObject | ( | OCI_Ref * | ref | ) |
#include <ocilib.h>
Returns the object pointed by the Ref handle.
ref | - Ref handle |
Referenced by ocilib::Reference::GetObject().
OCI_EXPORT boolean OCI_API OCI_RefIsNull | ( | OCI_Ref * | ref | ) |
#include <ocilib.h>
Check if the Ref points to an object or not.
ref | - Ref handle |
Referenced by ocilib::Reference::IsReferenceNull().
OCI_EXPORT boolean OCI_API OCI_RefSetNull | ( | OCI_Ref * | ref | ) |
#include <ocilib.h>
Nullify the given Ref handle.
ref | - Ref handle |
Referenced by ocilib::Reference::SetReferenceNull().
OCI_EXPORT unsigned int OCI_API OCI_RefGetHexSize | ( | OCI_Ref * | ref | ) |
#include <ocilib.h>
Returns the size of the hex representation of the given Ref handle.
ref | - Ref handle |
Referenced by ocilib::Reference::ToString().
OCI_EXPORT boolean OCI_API OCI_RefToText | ( | OCI_Ref * | ref, |
unsigned int | size, | ||
otext * | str | ||
) |
#include <ocilib.h>
Converts a Ref handle value to a hexadecimal string.
ref | - Ref handle |
size | - Destination string size in characters |
str | - Destination string |
Referenced by ocilib::Reference::ToString().