informix
Informix DataBlade API Programmer's Manual
DataBlade API Function Descriptions

mi_get_decimal()

The mi_get_decimal() function copies an mi_decimal (DECIMAL) value, converting any difference in alignment or byte order on the client computer to that of the server computer.

Syntax

Usage

The mi_get_decimal() function copies a value from the user-defined buffer that data_ptr references into the mi_decimal value that dec_ptr references. Upon completion, mi_get_decimal() returns the address of the position within the buffer to which data can be copied. The function advances the returned address by n bytes, ready for a subsequent copy. In other words, if n is the length of the value that dec_ptr identifies, the returned address is n bytes advanced from the original buffer address in data_ptr.

The mi_get_decimal() function is useful in a receive support function of an opaque data type that contains mi_decimal values. Use this function to receive an aligned numeric (DECIMAL) value from a client application, which possibly has unaligned data buffers.

Return Values

mi_unsigned_char1 * is the new address in the data_ptr data buffer.
NULL indicates that the function was not successful.

Related Topics

See the description of the following functions: mi_get_bytes(), mi_get_date(), mi_get_datetime(), mi_get_double_precision(), mi_get_int8(), mi_get_integer(), mi_get_interval(), mi_get_lo_handle(), mi_get_money(), mi_get_real(), mi_get_smallint(), mi_get_string(), and mi_put_decimal().

For more information on the use of mi_get_decimal() in a receive support function, see Converting Opaque-Type Data With Machine-Specific Data Types.


Informix DataBlade API Programmer's Manual, Version 9.2
Copyright © 1999, Informix Software, Inc. All rights reserved