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_string() functionThe mi_streamwrite_string() function writes an mi_string (CHAR(x)) value to a stream.

The mi_streamwrite_string() function

The mi_streamwrite_string() function writes an mi_string (CHAR(x)) value to a stream.

Syntax

mi_integer mi_streamwrite_string(stream, str_data, fparam_ptr)
   MI_STREAM *stream;
   mi_string *str_data;
   MI_FPARAM *fparam_ptr;

stream: A pointer to the stream descriptor for the open stream to which to write the character string.
str_data: A pointer to a buffer that contains the character string.
fparam_ptr: A pointer to the MI_FPARAM structure for the user-defined routine that calls mi_streamwrite_string().


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

Usage

The mi_streamwrite_string() function writes an mi_string value to the stream that stream references. The function writes the value that str_data 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_string() function is useful in a streamwrite() support function of an opaque data type that contains an mi_string value.

If code-set conversion is required, the mi_streamwrite_string() function converts the mi_string value from the code set of the client locale to that of the server-processing locale. For more information about code-set conversion, see the HCL OneDB™ GLS User's Guide.

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

Return values

>=0: The actual 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 stream references or the value that str_data references is invalid.
MI_ERROR: The function was not successful.