Informix DataBlade API Programmer's Manual DataBlade API Function Descriptions

The mi_collection_open() function opens a collection.

MI_COLL_DESC *mi_collection_open(conn, coll_struc)

MI_CONNECTION *conn;

MI_COLLECTION *coll_struc;

conn	is a pointer to the connection descriptor that a previous call to mi_open(), mi_server_connect(), or mi_server_reconnect() has established.
coll_struc	is a pointer to the collection structure to open.

Valid in Client LIBMI Application?	Valid in User-Defined Routine?
Yes	Yes

The mi_collection_open() function opens the collection that the coll_struc argument references. This function is a constructor function for the collection It creates a collection descriptor to this open collection. Other DataBlade API collection functions use this collection descriptor to access the elements of a collection.

The mi_collection_open() function allocates a new collection descriptor in the current memory duration.

The collection descriptor contains the collection cursor, which accesses elements of the collection. This cursor is an update scroll cursor. To use some other type of collection cursor for the collection, use the mi_collection_open_with_options() function.

See the descriptions of the following functions: mi_collection_close(), mi_collection_copy(), mi_collection_create(), mi_collection_delete(), mi_collection_fetch(), mi_collection_free(), mi_collection_insert(), mi_collection_open_with_options(), and mi_collection_update().

For a description of collections, see Collections.