Informix DataBlade API Programmer's Manual DataBlade API Function Descriptions

The mi_var_free() function frees the specified varying-length structure.

mi_integer mi_var_free (varlen_ptr)

mi_lvarchar *varlen_ptr

varlen_ptr

is the pointer to the varying-length structure to free.

;

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

The mi_var_free() function is a destructor function for a varying-length structure. It frees the varying-length structure that varlen_ptr references. Use mi_var_free() to explicitly free varying-length structures that you have allocated with the mi_new_var() function or that the mi_string_to_lvarchar() function has allocated.

Important: Do not use the DataBlade API memory-management function mi_free() to deallocate a varying-length structure.

Return Values

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

See the description of the following functions: mi_lvarchar_to_string(), mi_new_var(), mi_string_to_lvarchar(), mi_var_copy(), and mi_var_to_buffer().

For more information, see Managing Memory for a Varying-Length Structure.