The mi_streamwrite_lvarchar() function
The mi_streamwrite_lvarchar() function writes a varying-length structure (mi_lvarchar) value to a stream, converting any difference in the internal representation to that of the stream representation.
Syntax
mi_integer mi_streamwrite_lvarchar(strm_desc, varlen_ptr)
MI_STREAM *strm_desc;
mi_lvarchar *varlen_ptr;- strm_desc
- A pointer to the stream descriptor for the open stream to which to write the varying-length structure.
- varlen_ptr
- A pointer to the mi_lvarchar varying-length structure to write to the stream.
| Valid in client LIBMI application? | Valid in user-defined routine? |
|---|---|
| No | Yes |
Usage
The mi_streamwrite_lvarchar() function writes a varying-length structure to the stream that strm_desc references. The function writes the varying-length structure that varlen_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_lvarchar() function is useful in a streamwrite() support function of an opaque data type that contains a varying-length structure (such as mi_lvarchar).
For more information about the use of mi_streamwrite_lvarchar() 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 strm_desc references or the value that varlen_ptr references is invalid.
- MI_ERROR
- The function was not successful.