Home
Extending HCL OneDB™Beyond standard relational database objects, HCL OneDB™ can be extended to handle specialized data types, access methods, routines, and other objects. HCL OneDB™ includes many built-in extensions that are fully integrated in the database server. HCL OneDB™ also provides DataBlade® modules, which are packages of extended database objects for a particular purpose and that are installed separately from the database server. Alternatively, you can create your own user-defined objects for HCL OneDB™.
Creating extensionsYou can create user-defined data types, routines, access methods, and other database objects to suit your needs. You can use application programming interfaces to write user-defined routines and applications that access data in HCL OneDB™ databases.
DataBlade® API Function ReferenceThe HCL OneDB™ DataBlade® API Function Reference describes the DataBlade® API functions and the subset of functions that the DataBlade® API supports.
Function descriptionsThis section gives comprehensive reference information about the functions that are valid within DataBlade® API modules. It lists the function descriptions in alphabetical order, with syntax, usage information, and return values for the functions.
The mi_save_set_destroy() functionThe mi_save_set_destroy() function destroys a save set and frees its resources.

The mi_save_set_destroy() function

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: 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 the mi_save_set_create() function. 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: The function was successful.
MI_ERROR: The function was not successful.