The mi_stream_open_mi_lvarchar() function

The mi_stream_open_mi_lvarchar() function opens a new stream on varying-length data.

Syntax

MI_STREAM *mi_stream_open_mi_lvarchar(strm_desc, varlen_ptr)
   MI_STREAM *strm_desc;
   mi_lvarchar *varlen_ptr;
strm_desc
A pointer to a stream descriptor.
varlen_ptr
A pointer to a structure that contains varying-length data.
Valid in client LIBMI application? Valid in user-defined routine?
No Yes

Usage

The mi_stream_open_mi_lvarchar() initializes and opens a data stream on the varying-length structure that varlen_ptr references. To open a varying-length-data stream, mi_stream_open_mi_lvarchar() opens the stream on the data it is passed. Once it is opened, a varying-length-data stream has the same behavior as a string stream.

The mi_stream_open_mi_lvarchar() function returns a stream descriptor that identifies the varying-length-data stream. This function is a constructor function for a stream descriptor. It allocates the new stream descriptor in the current memory duration.

Return values

An MI_STREAM pointer
A pointer to the newly opened stream on the specified varying-length data.
NULL
The function was not successful.