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_eof() functionThe mi_stream_eof() function determines whether the current stream seek position is at the end of the stream.

The mi_stream_eof() function

The mi_stream_eof() function determines whether the current stream seek position is at the end of the stream.

Syntax

mi_integer mi_stream_eof(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_eof() function determines if the seek position of the stream that strm_desc references is currently at the end of the stream. You can use this function on any stream. The function does not have to be implemented for a user-defined stream.

Return values

MI_TRUE: The end of the stream has been reached.
MI_FALSE: The end of the stream has not been reached.
MI_STREAM_EBADARG: The stream descriptor that strm_desc references is invalid.