The mi_collection_free() function
The mi_collection_free() function frees a collection.
Syntax
mi_integer mi_collection_free(conn, coll_ptr)
MI_CONNECTION *conn;
MI_COLLECTION *coll_ptr;- conn
- A pointer to a connection descriptor established by a previous call to mi_open(), mi_server_connect(), or mi_server_reconnect().
- coll_ptr
- A pointer to the collection structure.
| Valid in client LIBMI application? | Valid in user-defined routine? |
|---|---|
| Yes | Yes |
Usage
The mi_collection_free() function frees the collection that coll_ptr references. This function is the destructor function for the collection structure.
For a description of collections, see the Informix® DataBlade® API Programmer's Guide.
Return values
- MI_OK
- The function was successful.
- MI_ERROR
- The function was not successful.