![]() |
OCILIB (C and C++ Driver for Oracle)
4.9.0
Open source and cross platform Oracle Driver delivering efficient access to Oracle databases.
|
OcilibCApiStatements
OCILIB supports the OCI data binding APIs.
Program variables can be bound to an Oracle SQL or PL/SQL statement in order to:
OCILIB provides a set of binding functions for the following data types:
To use binding:
Bindings can be:
Use OCI_BindSetDirection() to change a host variable's bind direction after the binding call but before statement execution. Each direction mode may have a slight overhead depending on the SQL type, as OCILIB may need to perform checks, conversions, or mappings between host variables and internal buffers. To maximize performance:
OCILIB supports the OCI array interface by binding arrays of C scalar types and OCILIB object types.
OCILIB does not pre-parse statements (unlike other frameworks such as JDBC) and lets Oracle recognize input variables embedded within the SQL statements.
Bind variables must be preceded in the SQL code by the ':' character.
Oracle and OCILIB support two binding modes:
The default binding mode is OCI_BIND_BY_NAME.
When using binding by position, provide the position to OCI_BindXXX() calls through the name parameter. The bind name must be the position preceded by a colon, e.g., ':1', ':2', etc.
Bind variables or arrays can be internally allocated by OCILIB. Instead of allocating variables or arrays on the stack/heap in the user program, bind contents can be allocated internally, which:
To use internal bind allocation:
Internal bind allocation IS compatible with ALL array binding OCI_BindArrayOfXXX() methods.
Internal bind allocation IS NOT compatible with the following single variable bind calls:
These methods require the data sub-type (e.g., OCI_CLOB/OCI_BLOB for LOBs) to internally create variables. Since their prototypes do not include the sub-type parameter, calling them with the bind mode set to OCI_BAM_INTERNAL will raise an OCILIB error of type OCI_ERR_NULL_POINTER.
Functions | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindArraySetSize (OCI_Statement *stmt, unsigned int size) |
| Set the input array size for bulk operations. | |
| OCI_SYM_PUBLIC unsigned int OCI_API | OCI_BindArrayGetSize (OCI_Statement *stmt) |
| Return the current input array size for bulk operations. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_AllowRebinding (OCI_Statement *stmt, boolean value) |
| Allow different host variables to be bound using the same bind name or position between executions of a prepared statement. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_IsRebindingAllowed (OCI_Statement *stmt) |
| Indicate if rebinding is allowed on the given statement. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindBoolean (OCI_Statement *stmt, const otext *name, boolean *data) |
| Bind a boolean variable (PL/SQL ONLY) | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindNumber (OCI_Statement *stmt, const otext *name, OCI_Number *data) |
| Bind a Number variable. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindArrayOfNumbers (OCI_Statement *stmt, const otext *name, OCI_Number **data, unsigned int nbelem) |
| Bind an array of Number. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindShort (OCI_Statement *stmt, const otext *name, short *data) |
| Bind a short variable. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindArrayOfShorts (OCI_Statement *stmt, const otext *name, short *data, unsigned int nbelem) |
| Bind an array of shorts. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindUnsignedShort (OCI_Statement *stmt, const otext *name, unsigned short *data) |
| Bind an unsigned short variable. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindArrayOfUnsignedShorts (OCI_Statement *stmt, const otext *name, unsigned short *data, unsigned int nbelem) |
| Bind an array of unsigned shorts. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindInt (OCI_Statement *stmt, const otext *name, int *data) |
| Bind an integer variable. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindArrayOfInts (OCI_Statement *stmt, const otext *name, int *data, unsigned int nbelem) |
| Bind an array of integers. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindUnsignedInt (OCI_Statement *stmt, const otext *name, unsigned int *data) |
| Bind an unsigned integer variable. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindArrayOfUnsignedInts (OCI_Statement *stmt, const otext *name, unsigned int *data, unsigned int nbelem) |
| Bind an array of unsigned integers. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindBigInt (OCI_Statement *stmt, const otext *name, big_int *data) |
| Bind a big integer variable. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindArrayOfBigInts (OCI_Statement *stmt, const otext *name, big_int *data, unsigned int nbelem) |
| Bind an array of big integers. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindUnsignedBigInt (OCI_Statement *stmt, const otext *name, big_uint *data) |
| Bind an unsigned big integer variable. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindArrayOfUnsignedBigInts (OCI_Statement *stmt, const otext *name, big_uint *data, unsigned int nbelem) |
| Bind an array of unsigned big integers. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindString (OCI_Statement *stmt, const otext *name, otext *data, unsigned int len) |
| Bind a string variable. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindArrayOfStrings (OCI_Statement *stmt, const otext *name, otext *data, unsigned int len, unsigned int nbelem) |
| Bind an array of strings. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindRaw (OCI_Statement *stmt, const otext *name, void *data, unsigned int len) |
| Bind a raw buffer. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindArrayOfRaws (OCI_Statement *stmt, const otext *name, void *data, unsigned int len, unsigned int nbelem) |
| Bind an array of raw buffers. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindDouble (OCI_Statement *stmt, const otext *name, double *data) |
| Bind a double variable. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindArrayOfDoubles (OCI_Statement *stmt, const otext *name, double *data, unsigned int nbelem) |
| Bind an array of doubles. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindFloat (OCI_Statement *stmt, const otext *name, float *data) |
| Bind a float variable. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindArrayOfFloats (OCI_Statement *stmt, const otext *name, float *data, unsigned int nbelem) |
| Bind an array of floats. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindDate (OCI_Statement *stmt, const otext *name, OCI_Date *data) |
| Bind a date variable. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindArrayOfDates (OCI_Statement *stmt, const otext *name, OCI_Date **data, unsigned int nbelem) |
| Bind an array of dates. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindTimestamp (OCI_Statement *stmt, const otext *name, OCI_Timestamp *data) |
| Bind a timestamp variable. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindArrayOfTimestamps (OCI_Statement *stmt, const otext *name, OCI_Timestamp **data, unsigned int type, unsigned int nbelem) |
| Bind an array of timestamp handles. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindInterval (OCI_Statement *stmt, const otext *name, OCI_Interval *data) |
| Bind an interval variable. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindArrayOfIntervals (OCI_Statement *stmt, const otext *name, OCI_Interval **data, unsigned int type, unsigned int nbelem) |
| Bind an array of interval handles. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindLob (OCI_Statement *stmt, const otext *name, OCI_Lob *data) |
| Bind a Lob variable. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindArrayOfLobs (OCI_Statement *stmt, const otext *name, OCI_Lob **data, unsigned int type, unsigned int nbelem) |
| Bind an array of Lob handles. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindFile (OCI_Statement *stmt, const otext *name, OCI_File *data) |
| Bind a File variable. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindArrayOfFiles (OCI_Statement *stmt, const otext *name, OCI_File **data, unsigned int type, unsigned int nbelem) |
| Bind an array of File handles. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindObject (OCI_Statement *stmt, const otext *name, OCI_Object *data) |
| Bind an object (named type) variable. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindArrayOfObjects (OCI_Statement *stmt, const otext *name, OCI_Object **data, OCI_TypeInfo *typinf, unsigned int nbelem) |
| Bind an array of object handles. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindVector (OCI_Statement *stmt, const otext *name, OCI_Vector *data) |
| Bind a Vector variable. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindArrayOfVectors (OCI_Statement *stmt, const otext *name, OCI_Vector **data, unsigned int nbelem) |
| Bind an array of Vector handles. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindColl (OCI_Statement *stmt, const otext *name, OCI_Coll *data) |
| Bind a Collection variable. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindArrayOfColls (OCI_Statement *stmt, const otext *name, OCI_Coll **data, OCI_TypeInfo *typinf, unsigned int nbelem) |
| Bind an array of Collection handles. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindRef (OCI_Statement *stmt, const otext *name, OCI_Ref *data) |
| Bind a Ref variable. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindArrayOfRefs (OCI_Statement *stmt, const otext *name, OCI_Ref **data, OCI_TypeInfo *typinf, unsigned int nbelem) |
| Bind an array of Ref handles. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindStatement (OCI_Statement *stmt, const otext *name, OCI_Statement *data) |
| Bind a Statement variable (PL/SQL Ref Cursor) | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindLong (OCI_Statement *stmt, const otext *name, OCI_Long *data, unsigned int size) |
| Bind a Long variable. | |
| OCI_SYM_PUBLIC OCI_Error *OCI_API | OCI_GetBatchError (OCI_Statement *stmt) |
| Return the first or next error that occurred within a DML array statement execution. | |
| OCI_SYM_PUBLIC unsigned int OCI_API | OCI_GetBatchErrorCount (OCI_Statement *stmt) |
| Return the number of errors that occurred within the last DML array statement. | |
| OCI_SYM_PUBLIC unsigned int OCI_API | OCI_GetBindCount (OCI_Statement *stmt) |
| Return the number of binds currently associated with a statement. | |
| OCI_SYM_PUBLIC OCI_Bind *OCI_API | OCI_GetBind (OCI_Statement *stmt, unsigned int index) |
| Return the bind handle at the given index in the internal array of bind handles. | |
| OCI_SYM_PUBLIC OCI_Bind *OCI_API | OCI_GetBind2 (OCI_Statement *stmt, const otext *name) |
| Return a bind handle from its name. | |
| OCI_SYM_PUBLIC unsigned int OCI_API | OCI_GetBindIndex (OCI_Statement *stmt, const otext *name) |
| Return the index of a bind from its name. | |
| OCI_SYM_PUBLIC const otext *OCI_API | OCI_BindGetName (OCI_Bind *bnd) |
| Return the name of the given bind. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindSetDirection (OCI_Bind *bnd, unsigned int direction) |
| Set the direction mode of a bind handle. | |
| OCI_SYM_PUBLIC unsigned int OCI_API | OCI_BindGetDirection (OCI_Bind *bnd) |
| Get the direction mode of a bind handle. | |
| OCI_SYM_PUBLIC unsigned int OCI_API | OCI_BindGetType (OCI_Bind *bnd) |
| Return the OCILIB type of the given bind. | |
| OCI_SYM_PUBLIC unsigned int OCI_API | OCI_BindGetSubtype (OCI_Bind *bnd) |
| Return the OCILIB object subtype of the given bind. | |
| OCI_SYM_PUBLIC unsigned int OCI_API | OCI_BindGetDataCount (OCI_Bind *bnd) |
| Return the number of elements of the bind handle. | |
| OCI_SYM_PUBLIC void *OCI_API | OCI_BindGetData (OCI_Bind *bnd) |
| Return the user defined data associated with a bind handle. | |
| OCI_SYM_PUBLIC OCI_Statement *OCI_API | OCI_BindGetStatement (OCI_Bind *bnd) |
| Return the statement handle associated with a bind handle. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindSetDataSize (OCI_Bind *bnd, unsigned int size) |
| Set the actual size of the element held by the given bind handle. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindSetDataSizeAtPos (OCI_Bind *bnd, unsigned int position, unsigned int size) |
| Set the size of the element at the given position in the bind input array. | |
| OCI_SYM_PUBLIC unsigned int OCI_API | OCI_BindGetDataSize (OCI_Bind *bnd) |
| Return the actual size of the element held by the given bind handle. | |
| OCI_SYM_PUBLIC unsigned int OCI_API | OCI_BindGetDataSizeAtPos (OCI_Bind *bnd, unsigned int position) |
| Return the actual size of the element at the given position in the bind input array. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindSetNull (OCI_Bind *bnd) |
| Set the bind variable to null. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindSetNullAtPos (OCI_Bind *bnd, unsigned int position) |
| Set to null the entry in the bind variable input array. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindSetNotNull (OCI_Bind *bnd) |
| Set the bind variable to NOT null. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindSetNotNullAtPos (OCI_Bind *bnd, unsigned int position) |
| Set to NOT null the entry in the bind variable input array. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindIsNull (OCI_Bind *bnd) |
| Check if the current value of the bound variable is marked as NULL. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindIsNullAtPos (OCI_Bind *bnd, unsigned int position) |
| Check if the current entry value at the given position in the bound array is marked as NULL. | |
| OCI_SYM_PUBLIC boolean OCI_API | OCI_BindSetCharsetForm (OCI_Bind *bnd, unsigned int csfrm) |
| Set the charset form of the given character based bind variable. | |
| OCI_SYM_PUBLIC unsigned int OCI_API | OCI_BindGetAllocationMode (OCI_Bind *bnd) |
| Get the allocation mode of a bind handle. | |
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindArraySetSize | ( | OCI_Statement * | stmt, |
| unsigned int | size | ||
| ) |
#include <api.h>
Set the input array size for bulk operations.
| stmt | - Statement handle |
| size | - Array size |
Referenced by ocilib::Statement::SetBindArraySize().
| OCI_SYM_PUBLIC unsigned int OCI_API OCI_BindArrayGetSize | ( | OCI_Statement * | stmt | ) |
#include <api.h>
Return the current input array size for bulk operations.
| stmt | - Statement handle |
Referenced by ocilib::Statement::GetBindArraySize().
| OCI_SYM_PUBLIC boolean OCI_API OCI_AllowRebinding | ( | OCI_Statement * | stmt, |
| boolean | value | ||
| ) |
#include <api.h>
Allow different host variables to be bound using the same bind name or position between executions of a prepared statement.
| stmt | - Statement handle |
| value | - Rebinding mode allowed |
Referenced by ocilib::Statement::AllowRebinding().
| OCI_SYM_PUBLIC boolean OCI_API OCI_IsRebindingAllowed | ( | OCI_Statement * | stmt | ) |
#include <api.h>
Indicate if rebinding is allowed on the given statement.
| stmt | - Statement handle |
Referenced by ocilib::Statement::IsRebindingAllowed().
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindBoolean | ( | OCI_Statement * | stmt, |
| const otext * | name, | ||
| boolean * | data | ||
| ) |
#include <api.h>
Bind a boolean variable (PL/SQL ONLY)
| stmt | - Statement handle |
| name | - Variable name |
| data | - Pointer to boolean variable |
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindNumber | ( | OCI_Statement * | stmt, |
| const otext * | name, | ||
| OCI_Number * | data | ||
| ) |
#include <api.h>
Bind a Number variable.
| stmt | - Statement handle |
| name | - Variable name |
| data | - Pointer to short variable |
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindArrayOfNumbers | ( | OCI_Statement * | stmt, |
| const otext * | name, | ||
| OCI_Number ** | data, | ||
| unsigned int | nbelem | ||
| ) |
#include <api.h>
Bind an array of Number.
| stmt | - Statement handle |
| name | - Variable name |
| data | - Array of numbers |
| nbelem | - Number of elements in the array (PL/SQL table only) |
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindShort | ( | OCI_Statement * | stmt, |
| const otext * | name, | ||
| short * | data | ||
| ) |
#include <api.h>
Bind a short variable.
| stmt | - Statement handle |
| name | - Variable name |
| data | - Pointer to short variable |
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindArrayOfShorts | ( | OCI_Statement * | stmt, |
| const otext * | name, | ||
| short * | data, | ||
| unsigned int | nbelem | ||
| ) |
#include <api.h>
Bind an array of shorts.
| stmt | - Statement handle |
| name | - Variable name |
| data | - Array of shorts |
| nbelem | - Number of elements in the array (PL/SQL table only) |
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindUnsignedShort | ( | OCI_Statement * | stmt, |
| const otext * | name, | ||
| unsigned short * | data | ||
| ) |
#include <api.h>
Bind an unsigned short variable.
| stmt | - Statement handle |
| name | - Variable name |
| data | - Pointer to unsigned short variable |
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindArrayOfUnsignedShorts | ( | OCI_Statement * | stmt, |
| const otext * | name, | ||
| unsigned short * | data, | ||
| unsigned int | nbelem | ||
| ) |
#include <api.h>
Bind an array of unsigned shorts.
| stmt | - Statement handle |
| name | - Variable name |
| data | - Array of unsigned shorts |
| nbelem | - Number of elements in the array (PL/SQL table only) |
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindInt | ( | OCI_Statement * | stmt, |
| const otext * | name, | ||
| int * | data | ||
| ) |
#include <api.h>
Bind an integer variable.
| stmt | - Statement handle |
| name | - Variable name |
| data | - Pointer to int variable |
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindArrayOfInts | ( | OCI_Statement * | stmt, |
| const otext * | name, | ||
| int * | data, | ||
| unsigned int | nbelem | ||
| ) |
#include <api.h>
Bind an array of integers.
| stmt | - Statement handle |
| name | - Variable name |
| data | - Array of int |
| nbelem | - Number of elements in the array (PL/SQL table only) |
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindUnsignedInt | ( | OCI_Statement * | stmt, |
| const otext * | name, | ||
| unsigned int * | data | ||
| ) |
#include <api.h>
Bind an unsigned integer variable.
| stmt | - Statement handle |
| name | - Variable name |
| data | - Pointer to unsigned int variable |
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindArrayOfUnsignedInts | ( | OCI_Statement * | stmt, |
| const otext * | name, | ||
| unsigned int * | data, | ||
| unsigned int | nbelem | ||
| ) |
#include <api.h>
Bind an array of unsigned integers.
| stmt | - Statement handle |
| name | - Variable name |
| data | - Array of unsigned int |
| nbelem | - Number of elements in the array (PL/SQL table only) |
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindBigInt | ( | OCI_Statement * | stmt, |
| const otext * | name, | ||
| big_int * | data | ||
| ) |
#include <api.h>
Bind a big integer variable.
| stmt | - Statement handle |
| name | - Variable name |
| data | - Pointer to big int variable |
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindArrayOfBigInts | ( | OCI_Statement * | stmt, |
| const otext * | name, | ||
| big_int * | data, | ||
| unsigned int | nbelem | ||
| ) |
#include <api.h>
Bind an array of big integers.
| stmt | - Statement handle |
| name | - Variable name |
| data | - Array of big int |
| nbelem | - Number of elements in the array (PL/SQL table only) |
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindUnsignedBigInt | ( | OCI_Statement * | stmt, |
| const otext * | name, | ||
| big_uint * | data | ||
| ) |
#include <api.h>
Bind an unsigned big integer variable.
| stmt | - Statement handle |
| name | - Variable name |
| data | - Pointer to unsigned big int variable |
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindArrayOfUnsignedBigInts | ( | OCI_Statement * | stmt, |
| const otext * | name, | ||
| big_uint * | data, | ||
| unsigned int | nbelem | ||
| ) |
#include <api.h>
Bind an array of unsigned big integers.
| stmt | - Statement handle |
| name | - Variable name |
| data | - Array of unsigned big int |
| nbelem | - Number of elements in the array (PL/SQL table only) |
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindString | ( | OCI_Statement * | stmt, |
| const otext * | name, | ||
| otext * | data, | ||
| unsigned int | len | ||
| ) |
#include <api.h>
Bind a string variable.
| stmt | - Statement handle |
| name | - Variable name |
| data | - String to bind |
| len | - Max length of the string (in character without the zero null terminal character) |
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindArrayOfStrings | ( | OCI_Statement * | stmt, |
| const otext * | name, | ||
| otext * | data, | ||
| unsigned int | len, | ||
| unsigned int | nbelem | ||
| ) |
#include <api.h>
Bind an array of strings.
| stmt | - Statement handle |
| name | - Variable name |
| data | - Array of string |
| len | - Max length of a single string element (in character without the zero null terminal character) |
| nbelem | - Number of elements in the array (PL/SQL table only) |
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindRaw | ( | OCI_Statement * | stmt, |
| const otext * | name, | ||
| void * | data, | ||
| unsigned int | len | ||
| ) |
#include <api.h>
Bind a raw buffer.
| stmt | - Statement handle |
| name | - Variable name |
| data | - buffer to bind |
| len | - Max length of the buffer |
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindArrayOfRaws | ( | OCI_Statement * | stmt, |
| const otext * | name, | ||
| void * | data, | ||
| unsigned int | len, | ||
| unsigned int | nbelem | ||
| ) |
#include <api.h>
Bind an array of raw buffers.
| stmt | - Statement handle |
| name | - Variable name |
| data | - Array of buffers |
| len | - Size in bytes on a single RAW array element |
| nbelem | - Number of elements in the array (PL/SQL table only) |
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindDouble | ( | OCI_Statement * | stmt, |
| const otext * | name, | ||
| double * | data | ||
| ) |
#include <api.h>
Bind a double variable.
| stmt | - Statement handle |
| name | - Variable name |
| data | - Pointer to double variable |
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindArrayOfDoubles | ( | OCI_Statement * | stmt, |
| const otext * | name, | ||
| double * | data, | ||
| unsigned int | nbelem | ||
| ) |
#include <api.h>
Bind an array of doubles.
| stmt | - Statement handle |
| name | - Variable name |
| data | - Array of double |
| nbelem | - Number of elements in the array (PL/SQL table only) |
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindFloat | ( | OCI_Statement * | stmt, |
| const otext * | name, | ||
| float * | data | ||
| ) |
#include <api.h>
Bind a float variable.
| stmt | - Statement handle |
| name | - Variable name |
| data | - Pointer to float variable |
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindArrayOfFloats | ( | OCI_Statement * | stmt, |
| const otext * | name, | ||
| float * | data, | ||
| unsigned int | nbelem | ||
| ) |
#include <api.h>
Bind an array of floats.
| stmt | - Statement handle |
| name | - Variable name |
| data | - Array of float |
| nbelem | - Number of elements in the array (PL/SQL table only) |
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindDate | ( | OCI_Statement * | stmt, |
| const otext * | name, | ||
| OCI_Date * | data | ||
| ) |
#include <api.h>
Bind a date variable.
| stmt | - Statement handle |
| name | - Variable name |
| data | - Date handle |
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindArrayOfDates | ( | OCI_Statement * | stmt, |
| const otext * | name, | ||
| OCI_Date ** | data, | ||
| unsigned int | nbelem | ||
| ) |
#include <api.h>
Bind an array of dates.
| stmt | - Statement handle |
| name | - Variable name |
| data | - Array of date handle |
| nbelem | - Number of elements in the array (PL/SQL table only) |
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindTimestamp | ( | OCI_Statement * | stmt, |
| const otext * | name, | ||
| OCI_Timestamp * | data | ||
| ) |
#include <api.h>
Bind a timestamp variable.
| stmt | - Statement handle |
| name | - Variable name |
| data | - Timestamp handle |
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindArrayOfTimestamps | ( | OCI_Statement * | stmt, |
| const otext * | name, | ||
| OCI_Timestamp ** | data, | ||
| unsigned int | type, | ||
| unsigned int | nbelem | ||
| ) |
#include <api.h>
Bind an array of timestamp handles.
| stmt | - Statement handle |
| name | - Variable name |
| data | - Array of Timestamp handle |
| type | - Timestamp type |
| nbelem | - Number of elements in the array (PL/SQL table only) |
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindInterval | ( | OCI_Statement * | stmt, |
| const otext * | name, | ||
| OCI_Interval * | data | ||
| ) |
#include <api.h>
Bind an interval variable.
| stmt | - Statement handle |
| name | - Variable name |
| data | - Interval handle |
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindArrayOfIntervals | ( | OCI_Statement * | stmt, |
| const otext * | name, | ||
| OCI_Interval ** | data, | ||
| unsigned int | type, | ||
| unsigned int | nbelem | ||
| ) |
#include <api.h>
Bind an array of interval handles.
| stmt | - Statement handle |
| name | - Variable name |
| data | - Array of Interval handle |
| type | - Interval type |
| nbelem | - Number of elements in the array (PL/SQL table only) |
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindLob | ( | OCI_Statement * | stmt, |
| const otext * | name, | ||
| OCI_Lob * | data | ||
| ) |
#include <api.h>
Bind a Lob variable.
| stmt | - Statement handle |
| name | - Variable name |
| data | - Lob handle |
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindArrayOfLobs | ( | OCI_Statement * | stmt, |
| const otext * | name, | ||
| OCI_Lob ** | data, | ||
| unsigned int | type, | ||
| unsigned int | nbelem | ||
| ) |
#include <api.h>
Bind an array of Lob handles.
| stmt | - Statement handle |
| name | - Variable name |
| data | - Array of Lob handle |
| type | - Lob type |
| nbelem | - Number of elements in the array (PL/SQL table only) |
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindFile | ( | OCI_Statement * | stmt, |
| const otext * | name, | ||
| OCI_File * | data | ||
| ) |
#include <api.h>
Bind a File variable.
| stmt | - Statement handle |
| name | - Variable name |
| data | - File handle |
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindArrayOfFiles | ( | OCI_Statement * | stmt, |
| const otext * | name, | ||
| OCI_File ** | data, | ||
| unsigned int | type, | ||
| unsigned int | nbelem | ||
| ) |
#include <api.h>
Bind an array of File handles.
| stmt | - Statement handle |
| name | - Variable name |
| data | - Array of File handle |
| type | - File type |
| nbelem | - Number of elements in the array (PL/SQL table only) |
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindObject | ( | OCI_Statement * | stmt, |
| const otext * | name, | ||
| OCI_Object * | data | ||
| ) |
#include <api.h>
Bind an object (named type) variable.
| stmt | - Statement handle |
| name | - Variable name |
| data | - Object handle |
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindArrayOfObjects | ( | OCI_Statement * | stmt, |
| const otext * | name, | ||
| OCI_Object ** | data, | ||
| OCI_TypeInfo * | typinf, | ||
| unsigned int | nbelem | ||
| ) |
#include <api.h>
Bind an array of object handles.
| stmt | - Statement handle |
| name | - Variable name |
| data | - Array of object handle |
| typinf | - type info handle |
| nbelem | - Number of elements in the array (PL/SQL table only) |
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindVector | ( | OCI_Statement * | stmt, |
| const otext * | name, | ||
| OCI_Vector * | data | ||
| ) |
#include <api.h>
Bind a Vector variable.
| stmt | - Statement handle |
| name | - Variable name |
| data | - Vector handle |
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindArrayOfVectors | ( | OCI_Statement * | stmt, |
| const otext * | name, | ||
| OCI_Vector ** | data, | ||
| unsigned int | nbelem | ||
| ) |
#include <api.h>
Bind an array of Vector handles.
| stmt | - Statement handle |
| name | - Variable name |
| data | - Array of Vector handle |
| nbelem | - Number of elements in the array (PL/SQL table only) |
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindColl | ( | OCI_Statement * | stmt, |
| const otext * | name, | ||
| OCI_Coll * | data | ||
| ) |
#include <api.h>
Bind a Collection variable.
| stmt | - Statement handle |
| name | - Variable name |
| data | - Collection handle to bind |
Referenced by ocilib::Statement::Bind().
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindArrayOfColls | ( | OCI_Statement * | stmt, |
| const otext * | name, | ||
| OCI_Coll ** | data, | ||
| OCI_TypeInfo * | typinf, | ||
| unsigned int | nbelem | ||
| ) |
#include <api.h>
Bind an array of Collection handles.
| stmt | - Statement handle |
| name | - Variable name |
| data | - Array of Collection handle |
| typinf | - Type info handle |
| nbelem | - Number of elements in the array (PL/SQL table only) |
Referenced by ocilib::Statement::Bind().
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindRef | ( | OCI_Statement * | stmt, |
| const otext * | name, | ||
| OCI_Ref * | data | ||
| ) |
#include <api.h>
Bind a Ref variable.
| stmt | - Statement handle |
| name | - Variable name |
| data | - Ref handle to bind |
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindArrayOfRefs | ( | OCI_Statement * | stmt, |
| const otext * | name, | ||
| OCI_Ref ** | data, | ||
| OCI_TypeInfo * | typinf, | ||
| unsigned int | nbelem | ||
| ) |
#include <api.h>
Bind an array of Ref handles.
| stmt | - Statement handle |
| name | - Variable name |
| data | - Array of Ref handle |
| typinf | - type info handle |
| nbelem | - Number of elements in the array (PL/SQL table only) |
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindStatement | ( | OCI_Statement * | stmt, |
| const otext * | name, | ||
| OCI_Statement * | data | ||
| ) |
#include <api.h>
Bind a Statement variable (PL/SQL Ref Cursor)
| stmt | - Statement handle |
| name | - Variable name |
| data | - Statement handle to bind |
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindLong | ( | OCI_Statement * | stmt, |
| const otext * | name, | ||
| OCI_Long * | data, | ||
| unsigned int | size | ||
| ) |
#include <api.h>
Bind a Long variable.
| stmt | - Statement handle |
| name | - Variable name |
| data | - Long handle |
| size | - Size of the long buffer in bytes or characters |
| OCI_SYM_PUBLIC OCI_Error *OCI_API OCI_GetBatchError | ( | OCI_Statement * | stmt | ) |
#include <api.h>
Return the first or next error that occurred within a DML array statement execution.
| stmt | - Statement handle |
Referenced by ocilib::Statement::GetBatchErrors().
| OCI_SYM_PUBLIC unsigned int OCI_API OCI_GetBatchErrorCount | ( | OCI_Statement * | stmt | ) |
#include <api.h>
Return the number of errors that occurred within the last DML array statement.
| stmt | - Statement handle |
| OCI_SYM_PUBLIC unsigned int OCI_API OCI_GetBindCount | ( | OCI_Statement * | stmt | ) |
#include <api.h>
Return the number of binds currently associated with a statement.
| stmt | - Statement handle |
Referenced by ocilib::Statement::GetBindCount().
| OCI_SYM_PUBLIC OCI_Bind *OCI_API OCI_GetBind | ( | OCI_Statement * | stmt, |
| unsigned int | index | ||
| ) |
#include <api.h>
Return the bind handle at the given index in the internal array of bind handles.
| stmt | - Statement handle |
| index | - Bind position (1-based) |
Referenced by ocilib::Statement::GetBind().
| OCI_SYM_PUBLIC OCI_Bind *OCI_API OCI_GetBind2 | ( | OCI_Statement * | stmt, |
| const otext * | name | ||
| ) |
#include <api.h>
Return a bind handle from its name.
| stmt | - Statement handle |
| name | - Bind variable name |
Referenced by ocilib::Statement::GetBind().
| OCI_SYM_PUBLIC unsigned int OCI_API OCI_GetBindIndex | ( | OCI_Statement * | stmt, |
| const otext * | name | ||
| ) |
#include <api.h>
Return the index of a bind from its name.
| stmt | - Statement handle |
| name | - Bind variable name |
Referenced by ocilib::Statement::GetBindIndex().
| OCI_SYM_PUBLIC const otext *OCI_API OCI_BindGetName | ( | OCI_Bind * | bnd | ) |
#include <api.h>
Return the name of the given bind.
| bnd | - Bind handle |
Referenced by ocilib::BindInfo::GetName().
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindSetDirection | ( | OCI_Bind * | bnd, |
| unsigned int | direction | ||
| ) |
#include <api.h>
Set the direction mode of a bind handle.
| bnd | - Bind handle |
| direction | - direction mode |
| OCI_SYM_PUBLIC unsigned int OCI_API OCI_BindGetDirection | ( | OCI_Bind * | bnd | ) |
#include <api.h>
Get the direction mode of a bind handle.
| bnd | - Bind handle |
Referenced by ocilib::BindInfo::GetDirection().
| OCI_SYM_PUBLIC unsigned int OCI_API OCI_BindGetType | ( | OCI_Bind * | bnd | ) |
#include <api.h>
Return the OCILIB type of the given bind.
| bnd | - Bind handle |
Referenced by ocilib::BindInfo::GetType().
| OCI_SYM_PUBLIC unsigned int OCI_API OCI_BindGetSubtype | ( | OCI_Bind * | bnd | ) |
#include <api.h>
Return the OCILIB object subtype of the given bind.
| bnd | - Bind handle |
For numeric binds the possible values are:
For OCI_Long type the possible values are:
For OCI_Lob type the possible values are:
For OCI_File type the possible values are:
For OCI_Timestamp type the possible values are:
For OCI_Interval type the possible values are:
Referenced by ocilib::BindInfo::GetSubType().
| OCI_SYM_PUBLIC unsigned int OCI_API OCI_BindGetDataCount | ( | OCI_Bind * | bnd | ) |
#include <api.h>
Return the number of elements of the bind handle.
| bnd | - Bind handle |
Referenced by ocilib::BindInfo::GetDataCount().
| OCI_SYM_PUBLIC void *OCI_API OCI_BindGetData | ( | OCI_Bind * | bnd | ) |
#include <api.h>
Return the user defined data associated with a bind handle.
| bnd | - Bind handle |
| OCI_SYM_PUBLIC OCI_Statement *OCI_API OCI_BindGetStatement | ( | OCI_Bind * | bnd | ) |
#include <api.h>
Return the statement handle associated with a bind handle.
| bnd | - Bind handle |
Referenced by ocilib::BindInfo::GetStatement().
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindSetDataSize | ( | OCI_Bind * | bnd, |
| unsigned int | size | ||
| ) |
#include <api.h>
Set the actual size of the element held by the given bind handle.
| bnd | - bind handle |
| size | - data size |
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindSetDataSizeAtPos | ( | OCI_Bind * | bnd, |
| unsigned int | position, | ||
| unsigned int | size | ||
| ) |
#include <api.h>
Set the size of the element at the given position in the bind input array.
| bnd | - Bind handle |
| position | - Position in the array (1-based) |
| size | - Data size |
| OCI_SYM_PUBLIC unsigned int OCI_API OCI_BindGetDataSize | ( | OCI_Bind * | bnd | ) |
#include <api.h>
Return the actual size of the element held by the given bind handle.
| bnd | - Bind handle |
| OCI_SYM_PUBLIC unsigned int OCI_API OCI_BindGetDataSizeAtPos | ( | OCI_Bind * | bnd, |
| unsigned int | position | ||
| ) |
#include <api.h>
Return the actual size of the element at the given position in the bind input array.
| bnd | - Bind handle |
| position | - Position in the array (1-based) |
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindSetNull | ( | OCI_Bind * | bnd | ) |
#include <api.h>
Set the bind variable to null.
| bnd | - Bind handle |
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindSetNullAtPos | ( | OCI_Bind * | bnd, |
| unsigned int | position | ||
| ) |
#include <api.h>
Set to null the entry in the bind variable input array.
| bnd | - Bind handle |
| position | - Position in the array |
Referenced by ocilib::BindInfo::SetDataNull().
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindSetNotNull | ( | OCI_Bind * | bnd | ) |
#include <api.h>
Set the bind variable to NOT null.
| bnd | - Bind handle |
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindSetNotNullAtPos | ( | OCI_Bind * | bnd, |
| unsigned int | position | ||
| ) |
#include <api.h>
Set to NOT null the entry in the bind variable input array.
| bnd | - Bind handle |
| position | - Position in the array |
Referenced by ocilib::BindInfo::SetDataNull().
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindIsNull | ( | OCI_Bind * | bnd | ) |
#include <api.h>
Check if the current value of the bound variable is marked as NULL.
| bnd | - Bind handle |
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindIsNullAtPos | ( | OCI_Bind * | bnd, |
| unsigned int | position | ||
| ) |
#include <api.h>
Check if the current entry value at the given position in the bound array is marked as NULL.
| bnd | - Bind handle |
| position | - Position in the array (1-based) |
Referenced by ocilib::BindInfo::IsDataNull().
| OCI_SYM_PUBLIC boolean OCI_API OCI_BindSetCharsetForm | ( | OCI_Bind * | bnd, |
| unsigned int | csfrm | ||
| ) |
#include <api.h>
Set the charset form of the given character based bind variable.
| bnd | - Bind handle |
| csfrm | - charset form |
Referenced by ocilib::BindInfo::SetCharsetForm().
| OCI_SYM_PUBLIC unsigned int OCI_API OCI_BindGetAllocationMode | ( | OCI_Bind * | bnd | ) |
#include <api.h>
Get the allocation mode of a bind handle.
| bnd | - Bind handle |