The mi_lo_stat_size() function
The mi_lo_stat_size() function obtains from an LO-status structure the size, in bytes, of a smart large object.
Syntax
mi_integer *mi_lo_stat_size(LO_stat, size)
MI_LO_STAT *LO_stat;
mi_int8 *size;- LO_stat
- A pointer to an LO-status structure that mi_lo_stat() allocates and fills in with status information.
- size
- A pointer to a user-allocated mi_int8 structure to receive the size, in bytes, of the smart large object.
| Valid in client LIBMI application? | Valid in user-defined routine? |
|---|---|
| Yes | Yes |
Usage
The mi_lo_stat_size() function
is the LO-status accessor function that returns the smart-large-object
size from a set of status information. This size is the actual number
of bytes that the smart-large-object data currently uses.
Important: Before you call mi_lo_stat_size(),
you must initialize an LO-status structure with the mi_lo_stat() function.
The mi_lo_stat_size() function obtains the smart-large-object size from the LO-status structure that LO_stat references.
For more information about the size of a smart large object or about how to use an LO-status structure, see the HCL OneDB™ DataBlade® API Programmer's Guide.
Return values
- MI_OK
- The function was successful.
- MI_ERROR
- The function was not successful.