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_stream_open_mi_lvarchar() functionThe mi_stream_open_mi_lvarchar() function opens a new stream on varying-length data.

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.