The mi_put_lo_handle() function

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.

Syntax

mi_unsigned_char1 *mi_put_lo_handle(data_ptr, LO_hdl)
   mi_unsigned_char1 *data_ptr;
   MI_LO_HANDLE *LO_hdl;
data_ptr
A pointer to the buffer to which to copy the LO handle.
LO_hdl
A pointer to the LO handle to copy to the buffer.
Valid in client LIBMI application? Valid in user-defined routine?
No Yes

Usage

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 position to which data can be copied in the data_ptr buffer. The function returns the data_ptr address advanced by nbytes 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 a smart large object. Use this function to send an LO-handle field of an opaque-type internal structure to a client application (which possibly has unaligned data buffers).

For more information about the use of mi_put_lo_handle() in a send support function, see the Informix® DataBlade® API Programmer's Guide.

Return values

An mi_unsigned_char1 pointer
The new address in the data_ptr data buffer.
NULL
The function was not successful.