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_streamwrite_collection() functionThe mi_streamwrite_collection() function writes a collection structure (LIST, SET, MULTISET) value to a stream, converting any difference in the internal representation to that of the stream representation.

The mi_streamwrite_collection() function

The mi_streamwrite_collection() function writes a collection structure (LIST, SET, MULTISET) value to a stream, converting any difference in the internal representation to that of the stream representation.

Syntax

mi_integer mi_streamwrite_collection(strm_desc, coll_ptr)
   MI_STREAM *strm_desc;
   MI_COLLECTION *coll_ptr;

strm_desc: A pointer to the stream descriptor for the open stream to which to write the collection structure (MI_COLLECTION).
coll_ptr: A pointer to the collection structure to write to the stream.


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

Important: Enterprise Replication does not support this function.

Usage

The mi_streamwrite_collection() function writes a collection structure to the stream that strm_desc stream references. The function writes the value that coll_ptr references. The write operation begins at the current stream seek position. You can use mi_stream_tell() or mi_stream_getpos() to obtain this seek position.

The mi_streamwrite_collection() function is useful in a streamwrite() support function of an opaque data type that contains a collection structure (MI_COLLECTION).

Important: The mi_streamwrite_collection() function requires the caller to have an open connection to the database server.

For more information about the use of mi_streamwrite_collection() in a streamwrite() support function, see the HCL OneDB™ DataBlade® API Programmer's Guide.

Return values

>=0: The number of bytes that the function has written to the open stream.
MI_STREAM_EEOF: The end of the stream has been reached.
MI_STREAM_EBADARG: The stream descriptor that strm_desc references or the value that coll_ptr references is invalid.
MI_ERROR: The function was not successful.