This section describes the OCI Table functions.
Function/Page | Purpose |
---|---|
Delete element |
|
Test whether element exists |
|
Return first index of table |
|
Return last index of table |
|
Return next available index of table |
|
Return previous available index of table |
|
Return current size of table |
Deletes the element at the specified index.
sword OCITableDelete ( OCIEnv *env, OCIError *err, sb4 index, OCITable *tbl );
The OCI environment handle initialized in object mode.
The OCI error handle. If there is an error, it is recorded in err
and this function returns OCI_ERROR
. Obtain diagnostic information by calling OCIErrorGet()
.
Index of the element which must be deleted.
Table whose element is deleted.
This function returns an error if the element at the given index has already been deleted or if the given index is not valid for the given table. It is also an error if any input parameter is NULL
.
Note:
The position ordinals of the remaining elements of the table are not changed byOCITableDelete()
. The delete operation creates holes in the table.OCIErrorGet(), OCITableExists()
Tests whether an element exists at the given index.
sword OCITableExists ( OCIEnv *env, OCIError *err, CONST OCITable *tbl, sb4 index, boolean *exists );
The OCI environment handle initialized in object mode.
The OCI error handle. If there is an error, it is recorded in err
and this function returns OCI_ERROR
. Obtain diagnostic information by calling OCIErrorGet()
.
Table in which the given index is checked.
Index of the element which is checked for existence.
Set to TRUE
if element at given index
exists; otherwise, it is set to FALSE
.
This function returns an error if any input parameter is NULL
.
OCIErrorGet(), OCITableDelete()
Returns the index of the first existing element in a given table.
sword OCITableFirst ( OCIEnv *env, OCIError *err, CONST OCITable *tbl, sb4 *index );
The OCI environment handle initialized in object mode.
The OCI error handle. If there is an error, it is recorded in err
and this function returns OCI_ERROR
. Obtain diagnostic information by calling OCIErrorGet()
.
Table to scan.
First index of the element which exists in the given table is returned.
For example, if OCITableDelete()
deleted the first 5 elements of a table, OCITableFirst()
returns 6.
This function returns an error if the table is empty.
OCIErrorGet(), OCITableDelete(), OCITableLast()
Returns the index of the last existing element of a table.
sword OCITableLast ( OCIEnv *env, OCIError *err, CONST OCITable *tbl, sb4 *index );
The OCI environment handle initialized in object mode.
The OCI error handle. If there is an error, it is recorded in err
and this function returns OCI_ERROR
. Obtain diagnostic information by calling OCIErrorGet()
.
Table to scan.
Index of the last existing element in the table.
This function returns an error if the table is empty.
OCIErrorGet(), OCITableFirst(), OCITableNext(), OCITablePrev()
Returns the index of the next existing element of a table.
sword OCITableNext ( OCIEnv *env, OCIError *err, sb4 index, CONST OCITable *tbl, sb4 *next_index boolean *exists );
The OCI environment handle initialized in object mode.
The OCI error handle. If there is an error, it is recorded in err
and this function returns OCI_ERROR
. Obtain diagnostic information by calling OCIErrorGet()
.
Index for starting point of scan.
Table to scan.
Index of the next existing element after tbl
(index
).
FALSE
if no next index is available, else TRUE
.
Returns the smallest position j, greater than index
, such that exists(j)
is TRUE
.
See Also:
Refer to the description of OCIStringAllocSize(), regarding the existence of non-data holes in tables.Returns the index of the previous existing element of a table.
sword OCITablePrev ( OCIEnv *env, OCIError *err, sb4 index, CONST OCITable *tbl, sb4 *prev_index boolean *exists );
The OCI environment handle initialized in object mode.
The OCI error handle. If there is an error, it is recorded in err
and this function returns OCI_ERROR
. Obtain diagnostic information by calling OCIErrorGet()
.
Index for starting point of scan.
Table to scan.
Index of the previous existing element before tbl
(index
).
FALSE
if no previous index is available, else TRUE
.
Return the largest position j
, less than index
, such that exists(j
) is TRUE
.
See Also:
Refer to the description of OCIStringAllocSize(), regarding the existence of non-data holes in tables.Returns the size of the given table, not including deleted elements.
sword OCITableSize ( OCIEnv *env, OCIError *err, CONST OCITable *tbl sb4 *size );
The OCI environment handle initialized in object mode.
The OCI error handle. If there is an error, it is recorded in err
and this function returns OCI_ERROR
. Obtain diagnostic information by calling OCIErrorGet()
.
Nested table whose number of elements is returned.
Current number of elements in the nested table. The count does not include deleted elements.
The count will be decremented upon deleting elements from the nested table. So this count does not include any holes created by deleting elements. To get the count not including the deleted elements, use OCICollSize().
For example:
OCITableSize(...); // assume 'size' returned is equal to 5 OCITableDelete(...); // delete one element OCITableSize(...); // 'size' returned is equal to 4
To get the count plus the count of deleted elements use OCICollSize()
. Continuing the previous example:
OCICollSize(...) // 'size' returned is still equal to 5
This function returns an error if an error occurs during the loading of the nested table into the object cache, or if any of the input parameters is NULL
.