The mi_streamread_datetime() function

The mi_streamread_datetime() function reads an mi_datetime (DATETIME) value from a stream, converting any difference in the stream representation to that of the internal representation.

Syntax

mi_integer mi_streamread_datetime(strm_desc, dtime_dptr)
   MI_STREAM *strm_desc;
   mi_datetime **dtime_dptr;
strm_desc
A pointer to the stream descriptor for the open stream from which to read the mi_datetime value.
dtime_dptr
A pointer to the buffer into which to copy the address of the mi_datetime value.
Valid in client LIBMI application? Valid in user-defined routine?
No Yes

Usage

The mi_streamread_datetime() function reads an mi_datetime value from the stream that strm_desc references. The function reads the mi_datetime value from the stream and puts the address of the value in the buffer that dtime_dptr references. The read operation begins at the current stream seek position. You can use mi_stream_tell() or mi_stream_getpos() to obtain this seek position.

When *dtime_dptr points to NULL, mi_streamread_datetime() allocates the memory for the buffer in the current memory duration. Otherwise, the function assumes that you have allocated the memory that *dtime_dptr references.
Important: Be sure that *dtime_dptr points to NULL if the parameter does not point to valid memory.

The mi_streamread_datetime() function is useful in a streamread() support function of an opaque data type that contains an mi_datetime value.

For more information about the use of mi_streamread_datetime() in a streamread() support function, see the Informix® DataBlade® API Programmer's Guide.

Return values

>=0
The number of bytes that the function has read from the open stream to the value that dtime_dptr references.
MI_STREAM_EEOF
The end of the stream has been reached without any errors.
MI_STREAM_EBADARG
The stream descriptor that strm_desc references or the value that dtime_dptr references is invalid.
MI_ERROR
The function was not successful.