Home
Extending HCL OneDB™Beyond standard relational database objects, HCL OneDB™ can be extended to handle specialized data types, access methods, routines, and other objects. HCL OneDB™ includes many built-in extensions that are fully integrated in the database server. HCL OneDB™ also provides DataBlade® modules, which are packages of extended database objects for a particular purpose and that are installed separately from the database server. Alternatively, you can create your own user-defined objects for HCL OneDB™.
Creating extensionsYou can create user-defined data types, routines, access methods, and other database objects to suit your needs. You can use application programming interfaces to write user-defined routines and applications that access data in HCL OneDB™ databases.
DataBlade® API Function ReferenceThe HCL OneDB™ DataBlade® API Function Reference describes the DataBlade® API functions and the subset of functions that the DataBlade® API supports.
Function descriptionsThis section gives comprehensive reference information about the functions that are valid within DataBlade® API modules. It lists the function descriptions in alphabetical order, with syntax, usage information, and return values for the functions.
The mi_collection_close() functionThe mi_collection_close() function closes a collection and frees the collection descriptor.

The mi_collection_close() function

The mi_collection_close() function closes a collection and frees the collection descriptor.

Syntax

mi_integer mi_collection_close(conn, coll_desc)
   MI_CONNECTION *conn;
   MI_COLL_DESC *coll_desc;

conn: A pointer to a connection descriptor established by a previous call to mi_open(), mi_server_connect(), or mi_server_reconnect().
coll_desc: A pointer to the collection descriptor.


Valid in client LIBMI application?	Valid in user-defined routine?
Yes	Yes

Usage

The mi_collection_close() function performs the following tasks:

It closes and frees the collection cursor that is associated with the collection descriptor that coll_desc references.
It frees the collection descriptor that coll_desc references.

This collection was opened by a previous call to the mi_collection_open() or mi_collection_open_with_options() function. This function is the destructor function for the collection descriptor and the associated collection cursor.

Important: When you close a collection cursor with mi_collection_close(), the cursor does not remain allocated. To reuse the cursor, you must re-create it with the mi_collection_open() function. When you free a collection descriptor with mi_collection_close(), the collection structure remains allocated.

For a description of collections, see the HCL OneDB™ DataBlade® API Programmer's Guide.

Return values

MI_OK: The function was successful.
MI_ERROR: The function was not successful.