Home | Previous Page | Next Page   Function Descriptions >

mi_collection_free( )

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
is a pointer to a connection descriptor established by a previous call to mi_open( ), mi_server_connect( ), or mi_server_reconnect( ).
coll_ptr
is 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.

Return Values

MI_OK
indicates that the function was successful.
MI_ERROR
indicates that the function was not successful.

Related Topics

See also the descriptions of mi_collection_close( ), mi_collection_copy( ), mi_collection_create( ), mi_collection_delete( ), mi_collection_fetch( ), mi_collection_insert( ), mi_collection_open( ), mi_collection_update( ), mi_open( ), mi_server_connect( ), and mi_server_reconnect( ).

For a description of collections, see the IBM Informix: DataBlade API Programmer's Guide.

Home | [ Top of Page | Previous Page | Next Page | Contents | Index ]