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_str() functionThe mi_stream_open_str() function opens a new stream on a character string.

The mi_stream_open_str() function

The mi_stream_open_str() function opens a new stream on a character string.

Syntax

mi_integer mi_stream_open_str(strm_desc, str_ptr, str_len)
   MI_STREAM *strm_desc;
   char *str_ptr;
   mi_integer str_len;

strm_desc: A pointer to a stream descriptor.
str_ptr: A pointer to a character string.
str_len: The length of the character string that str_ptr references.


Valid in client LIBMI application?	Valid in user-defined routine?
No	Yes

Usage

The mi_stream_open_str() function initializes and opens a data stream on the character string that str_ptr references. This function returns a stream descriptor that identifies the string stream. This function is a constructor function for a stream descriptor. It allocates the new stream descriptor in the current memory duration.

Tip: The stream operates on a copy of the passed string, so changes to the string are not reflected in the stream, and changes to the stream are not reflected in the string.

Return values

An MI_STREAM pointer: A pointer to the newly opened stream on the specified string data.
NULL: The function was not successful.