Home | Previous Page | Next Page   Function Descriptions >

mi_streamread_smallint( )

The mi_streamread_smallint( ) function reads an mi_smallint (SMALLINT) value from a stream, converting any difference in the stream representation to that of the internal representation.

Syntax

mi_integer mi_streamread_smallint(strm_desc, smallint_ptr)
   MI_STREAM *strm_desc;
   mi_smallint *smallint_ptr;
strm_desc
is a pointer to the stream descriptor for the open stream from which to read the mi_smallint value.
smallint_ptr
is a pointer to the buffer into which to copy the mi_smallint value.
Valid in Client LIBMI Application? Valid in User-Defined Routine?
No Yes

Usage

The mi_streamread_smallint( ) function reads an mi_smallint value from the stream that strm_desc references. The function reads this value into the mi_smallint buffer that smallint_ptr 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.

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

Return Values

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

Related Topics

See also the descriptions of mi_stream_getpos( ), mi_stream_read( ), mi_stream_tell( ), and mi_streamwrite_smallint( ).

For more information on the use of mi_streamread_smallint( ) in a streamread( ) support function, see the IBM Informix: DataBlade API Programmer's Guide.

Home | [ Top of Page | Previous Page | Next Page | Contents | Index ]