The mi_streamwrite_row() function
The mi_streamwrite_row() function writes a row structure (row type) value to a stream, converting any difference in the internal representation to that of the stream representation.
Syntax
mi_integer mi_streamwrite_row(strm_desc, rowstruc_ptr, fparam_ptr)
MI_STREAM *strm_desc;
MI_ROW *rowstruc_ptr;
MI_FPARAM *fparam_ptr;- strm_desc
- A pointer to the stream descriptor for the open stream to which to write the row structure (MI_ROW).
- rowstruc_ptr
- A pointer to the row structure to write to the stream.
- fparam_ptr
- A pointer to the MI_FPARAM structure for the user-defined routine that calls mi_streamwrite_row().
| Valid in client LIBMI application? | Valid in user-defined routine? |
|---|---|
| No | Yes |
Important: Enterprise Replication does
not support this function.
Usage
The mi_streamwrite_row() function writes a row structure to the stream that strm_desc references. The function writes the value that rowstruc_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_row() function
is useful in a streamwrite() support function of
an opaque data type that contains a row structure (MI_ROW).
Important: The mi_streamwrite_row() function
requires the caller to have an open connection to the database server.
For more information about the use of mi_streamwrite_row() 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 rowstruc_ptr references is invalid.
- MI_ERROR
- The function was not successful.