Informix DataBlade API Programmer's Manual DataBlade API Function Descriptions

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

mi_unsigned_char1 *mi_get_integer (data_ptr, int_ptr)

mi_unsigned_char1 *data_ptr;

mi_integer *int_ptr;

data_ptr	is a pointer to the buffer from which to copy an mi_integer value.
int_ptr	is a pointer to the buffer to which to copy the mi_integer value.

Valid in Client LIBMI Application?	Valid in User-Defined Routine?
No	Yes

The mi_get_integer() function copies a value from the user-defined buffer that data_ptr references into the mi_integer value that int_ptr references. Upon completion, mi_get_integer() 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 int_ptr identifies, the returned address is advanced n bytes from the original buffer address in data_ptr.

The mi_get_integer() function is useful in a receive support function of an opaque data type that contains mi_integer values. Use this function to receive an aligned 4-byte integer (INTEGER) value from a client application, which possibly has unaligned data buffers.

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

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