The mi_put_interval() function
The mi_put_interval() function copies an mi_interval (INTERVAL) 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_interval(data_ptr, intrvl_ptr)
mi_unsigned_char1 *data_ptr;
mi_interval *intrvl_ptr;- data_ptr
- A pointer to the buffer to which to copy the mi_interval value.
- intrvl_ptr
- A pointer to the buffer from which to copy the mi_interval value.
| Valid in client LIBMI application? | Valid in user-defined routine? |
|---|---|
| No | Yes |
Usage
The mi_put_interval() function copies the mi_interval value from the buffer that intrvl_ptr references into the user-defined buffer that data_ptr references. Upon completion, mi_put_interval() 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 intrvl_ptr identifies, the returned address is n bytes advanced from the original buffer address in data_ptr.
The mi_put_interval() function is useful in a send support function of an opaque data type that contains an mi_interval value. Use this function to send an mi_interval 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_interval() 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.