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_close() functionThe mi_stream_close() function closes a stream.

The mi_stream_close() function

The mi_stream_close() function closes a stream.

Syntax

mi_integer mi_stream_close(strm_desc)
   MI_STREAM *strm_desc;

strm_desc: A pointer to a stream descriptor for an open stream.


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

Usage

The mi_stream_close() function closes the stream that strm_desc identifies. To close the stream, mi_stream_close() uses the stream-close function that the stream-operations structure contains.

When it closes a stream, mi_stream_close() also deallocates the MI_STREAM structure, unless the MI_STREAM structure was passed as an argument to mi_stream_init(). Calling mi_stream_close() to close a stream of a predefined stream class always deallocates the MI_STREAM structure; mi_stream_close() is the destructor function for a stream descriptor.

Important: The mi_stream_close() function can free a stream descriptor only if mi_stream_init() allocated it. If your user-defined stream-open function has allocated its own stream descriptor, mi_stream_close() does not free this descriptor.

Return values

MI_OK: The stream has been closed.
MI_STREAM_EBADARG: The stream descriptor that strm_desc references is invalid.
MI_STREAM_ENIMPL: The stream class does not implement the stream-close function.
MI_ERROR: The function was not successful.