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_length() functionThe mi_stream_length() function obtains the length of an open stream.

The mi_stream_length() function

The mi_stream_length() function obtains the length of an open stream.

Syntax

mi_integer mi_stream_length(strm_desc, len)
   MI_STREAM *strm_desc;
   mi_int8 *len;

strm_desc: A pointer to a stream descriptor for an open stream.
len: A pointer to an eight-byte integer (mi_int8).


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

Usage

The mi_stream_length() function gets the length the data in the stream that strm_desc references. The function returns the length of the stream data in the len parameter.

Return values

MI_OK: The function was successful.
MI_STREAM_EBADARG: The stream descriptor that strm_desc references is invalid or that the specified length is less than zero.
MI_STREAM_ENIMPL: The stream class does not implement the stream-length function.
MI_ERROR: The function was not successful.
MI_STREAM_EFAIL: The function was not successful for a file stream.