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

mi_get_bytes()

The mi_get_bytes() function copies the given number of bytes, converting any difference in alignment or byte order on the client computer to that of the server computer.

Syntax

Usage

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

The mi_get_bytes() function is useful in a receive support function of an opaque data type when aligned values need to be obtained from possibly unaligned data buffers of a client application.

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_fix_integer(), mi_fix_smallint(), mi_get_date(), mi_get_datetime(), mi_get_decimal(), 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_bytes().

For more information on the use of mi_get_bytes() 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