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_get_money() functionThe mi_get_money() function copies an mi_money (MONEY) value, converting any difference in alignment or byte order on the client computer to that of the server computer.

The mi_get_money() function

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

Syntax

mi_unsigned_char1 *mi_get_money(data_ptr, money_ptr)
   mi_unsigned_char1 *data_ptr;
   mi_money *money_ptr;

data_ptr

A pointer to the buffer from which to copy the mi_money value.

money_ptr

A pointer to the buffer to which to copy the mi_money value.


Valid in client LIBMI application?	Valid in user-defined routine?
No	Yes

Usage

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

The mi_get_money() function is useful in a receive support function of an opaque data type that contains an mi_money value. Use this function to receive an mi_money field of an opaque-type internal structure from a client application (which possibly has unaligned data buffers).

For more information about the use of mi_get_money() in a receive 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.