Informix DataBlade API Programmer's Manual DataBlade API Function Descriptions

The mi_collection_open_with_options() function opens a collection in a specified open mode.

MI_COLL_DESC *mi_collection_open(conn, coll_struc, control)

MI_CONNECTION *conn;

MI_COLLECTION *coll_struc;

mi_integer control;

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.
control	is a bit-mask integer value that specifies the type of collection cursor to create and open. Valid bit-mask flags are the following:
	MI_COLL_READONLY	Cursor is read-only.
	MI_COLL_NOSCROLL	Cursor is a sequential cursor (not a scroll cursor).

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

The mi_collection_open_with_options() function is a constructor function for the collection descriptor. It opens the collection that the coll_struc argument references and returns 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_with_options() function allocates a new collection descriptor in the current memory duration.

This function is useful for accessing collection subqueries.

This function creates a collection cursor to hold the collection elements. By default, this cursor is an update scroll cursor. If this type of cursor is not adequate for your DataBlade API module, you can create a collection cursor with characteristics specified by a bit mask in the control argument.

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(), and mi_collection_update().