The mi_put_money() function
The mi_put_money() function copies an mi_money (MONEY) value, converting any difference in alignment or byte order on the server computer to that of the client computer.
Syntax
mi_unsigned_char1 *mi_put_money(data_ptr, money_ptr)
mi_unsigned_char1 *data_ptr;
mi_money *money_ptr;- data_ptr
- A pointer to the buffer to which to copy the mi_money value.
- money_ptr
- A pointer to the buffer from which to copy the mi_money value.
| Valid in client LIBMI application? | Valid in user-defined routine? |
|---|---|
| No | Yes |
Usage
The mi_put_money() function copies the mi_money value from the buffer that money_ptr references into the user-defined buffer that data_ptr references. Upon completion, mi_put_money() 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 money_ptr identifies, the returned address is n bytes advanced from the original buffer address in data_ptr.
The mi_put_money() function is useful in a send support function of an opaque data type that contains an mi_money value. Use this function to send an mi_money 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_money() 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.