Home | Previous Page | Next Page   Function Descriptions >

mi_new_var( )

The mi_new_var( ) function creates a new varying-length structure for text data.

Syntax

mi_lvarchar *mi_new_var(data_len)
   mi_integer data_len;
data_len
is the length of the data to store in the new varying-length structure.
Valid in Client LIBMI Application? Valid in User-Defined Routine?
Yes Yes

Usage

The mi_new_var( ) function is a constructor function for a varying-length structure. It allocates a varying-length structure with data_len bytes of data in its data portion. The function allocates memory for the varying-length structure that it returns. Therefore, you must use the mi_var_free( ) function to free this structure when it is no longer needed.

Server Only

The mi_new_var( ) function allocates a new varying-length structure with the current memory duration.

End of Server Only
Important:
Do not use the DataBlade API memory-management functions such as mi_alloc( ) to allocate a varying-length structure.

Return Values

An mi_lvarchar pointer
is a pointer to the new variable-length structure.
NULL
indicates that the function was not successful.

Related Topics

See also the descriptions of mi_get_vardata( ), mi_get_vardata_align( ), mi_get_varlen( ), mi_lvarchar_to_string( ), mi_set_vardata( ), mi_set_vardata_align( ), mi_set_varlen( ), mi_string_to_lvarchar( ), mi_var_copy( ), and mi_var_free( ).

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