Informix DataBlade API Programmer's Manual DataBlade API Function Descriptions

The mi_put_lo_handle() function copies an LO handle, converting any difference in alignment or byte order on the server computer to that of the client computer.

mi_unsigned_char1 *mi_put_lo_handle(data_ptr, LO_hdl)

mi_unsigned_char1 *data_ptr;

MI_LO_HANDLE *LO_hdl;

data_ptr	is a pointer to the buffer to which the LO handle is to be copied.
LO_hdl	is a pointer to LO handle to copy to the buffer.

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

The mi_put_lo_handle() function copies the LO handle that LO_hdl references into the user-defined buffer that data_ptr references. Upon completion, mi_put_lo_handle() returns the address of the next buffer to which data can be copied. The function advances the returned address by n bytes, ready for copying in the next value. In other words, if n is the length of the value that LO_hdl identifies, the returned address is n bytes advanced from the original buffer address in data_ptr.

The mi_put_lo_handle() function is useful in a send support function of an opaque data type that contains smart large objects. Use this function to send an aligned LO handle to a client application, which possibly has unaligned data buffers.

See the description of the following functions: mi_get_lo_handle(), mi_put_bytes(), mi_put_date(), mi_put_datetime(), mi_put_decimal(), mi_put_double_precision(), mi_put_int8(), mi_put_integer(), mi_put_interval(), mi_put_money(), mi_put_real(), mi_put_smallint(), and mi_put_string().

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