The mi_string_to_lvarchar() function

The mi_string_to_lvarchar() function converts a null-terminated string to a varying-length structure.

Syntax

mi_lvarchar *mi_string_to_lvarchar(str)
   mi_string *str;
str
The string to convert to a varying-length structure.
Valid in Client Application? Valid in user-defined routine?
Yes Yes

Usage

The mi_string_to_lvarchar() function stores the null-terminated string that str references into the data portion of a new varying-length structure. It does not copy the null terminator. This function is a constructor function for a varying-length structure. 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_string_to_lvarchar() function allocates a new varying-length structure with the current memory duration.

Return values

An mi_lvarchar pointer
A pointer to the allocated varying-length structure.
NULL
The function was not successful.