Close a collection

A collection descriptor contains a collection cursor. The scope of the collection descriptor and its associated collection cursor is from the time they are created, by mi_collection_open_with_options() or mi_collection_open(), until one of the following events occurs:
  • The mi_collection_close() function frees the collection descriptor, thereby closing and freeing the associated collection cursor.
  • The current memory duration expires. (Server only)
  • The mi_close() function closes the connection.

To conserve resources, use the mi_collection_close() function to free the collection descriptor as soon as your DataBlade® API module no longer needs it. This function also explicitly closes and frees the associated collection cursor. The mi_collection_close() function is the destructor function for the collection descriptor as well as for its associated cursor.