Home
Extending HCL OneDB™Beyond standard relational database objects, HCL OneDB™ can be extended to handle specialized data types, access methods, routines, and other objects. HCL OneDB™ includes many built-in extensions that are fully integrated in the database server. HCL OneDB™ also provides DataBlade® modules, which are packages of extended database objects for a particular purpose and that are installed separately from the database server. Alternatively, you can create your own user-defined objects for HCL OneDB™.
Creating extensionsYou can create user-defined data types, routines, access methods, and other database objects to suit your needs. You can use application programming interfaces to write user-defined routines and applications that access data in HCL OneDB™ databases.
DataBlade® API Function ReferenceThe HCL OneDB™ DataBlade® API Function Reference describes the DataBlade® API functions and the subset of functions that the DataBlade® API supports.
Function descriptionsThis section gives comprehensive reference information about the functions that are valid within DataBlade® API modules. It lists the function descriptions in alphabetical order, with syntax, usage information, and return values for the functions.
The mi_put_lo_handle() functionThe 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.

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 HCL OneDB™ 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.