Home | Previous Page | Next Page   Function Descriptions >

mi_streamwrite_decimal( )

The mi_streamwrite_decimal( ) function writes an mi_decimal (DECIMAL) value to a stream, converting any difference in the internal representation to that of the stream representation.

Syntax

mi_integer mi_streamwrite_decimal(strm_desc, dec_ptr)
   MI_STREAM *strm_desc;
   mi_decimal *dec_ptr;
strm_desc
is a pointer to the stream descriptor for the open stream to which to write the mi_decimal value.
dec_ptr
is a pointer to the mi_decimal value to write to the stream.
Valid in Client LIBMI Application? Valid in User-Defined Routine?
No Yes

Usage

The mi_streamwrite_decimal( ) function writes an mi_decimal value to the stream that strm_desc references. The function writes the value that dec_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_decimal( ) function is useful in a streamwrite( ) support function of an opaque data type that contains an mi_decimal value.

Return Values

>=0
is the actual number of bytes that the function has written to the open stream.
MI_STREAM_EEOF
indicates that the end of the stream has been reached.
MI_STREAM_EBADARG
indicates that the stream descriptor that strm_desc references or the value that dec_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_streamread_decimal( ).

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

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