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_getpos() functionThe mi_stream_getpos() function returns the current seek position of an open stream.

The mi_stream_getpos() function

The mi_stream_getpos() function returns the current seek position of an open stream.

Syntax

mi_integer mi_stream_getpos(strm_desc, seek_pos)
   MI_STREAM *strm_desc;
   mi_int8 *seek_pos;

strm_desc: A pointer to a stream descriptor for an open stream.
seek_pos: 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_getpos() function obtains the current seek position of the stream that strm_desc references. The stream seek position is the offset for the next read or write operation on the stream. The mi_stream_getpos() function returns this seek position in the mi_int8 variable that seek_pos references.

Return values

MI_OK: The seek_pos variable contains the current stream seek position, measured in the number of bytes from the beginning of the stream.
MI_STREAM_EBADARG: The stream descriptor that strm_desc references or the seek_pos value is invalid.
MI_STREAM_ENIMPL: The stream class does not implement the seek position.
MI_ERROR: The function was not successful.