Home | Previous Page | Next Page   Function Descriptions >

mi_save_set_destroy( )

The mi_save_set_destroy( ) function destroys a save set and frees its resources.

Syntax

mi_integer mi_save_set_destroy(save_set)
   MI_SAVE_SET *save_set;
save_set
is a pointer to an MI_SAVE_SET structure.
Valid in Client LIBMI Application? Valid in User-Defined Routine?
Yes Yes

Usage

The mi_save_set_destroy( ) function frees resources for the save set that save_set references. This function is the destructor function for a save set. This save set must have been previously created with mi_save_set_create( ). It is an error to attempt to access rows in a save set that was destroyed.

Important:
It is recommended that you explicitly deallocate save sets with mi_save_set_destroy( ) once you no longer need them. Otherwise, these save sets remain until the associated SQL statement ends or the session closes (whichever occurs first).

Return Values

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

Related Topics

See also the description of mi_save_set_create( ).

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