The mi_lo_specset_maxbytes() function
The mi_lo_specset_maxbytes() function sets the maximum number of bytes allowed for a smart large object.
Syntax
mi_integer mi_lo_specset_maxbytes(LO_spec, maxbytes)
MI_LO_SPEC *LO_spec;
mi_int8 *maxbytes;
- LO_spec
- A pointer to the LO-specification structure in which to save the maximum size.
- maxbytes
- A pointer to an eight-byte integer (mi_int8) structure that contains the maximum number of bytes for the smart large object.
Valid in client LIBMI application? | Valid in user-defined routine? |
---|---|
Yes | Yes |
Usage
The mi_lo_specset_maxbytes() function
is the LO-specification accessor function that sets the maximum size
of a new smart large object. When you set a maximum size, the smart-large-object
optimizer does not allow the size of a smart large object to exceed
the maxbytes value. Most applications do not need to specify
a maximum size.
Important: Before you call mi_lo_specset_maxbytes(),
you must initialize an LO-specification structure.
After you set the maximum size in an LO-specification structure, you pass this structure to a smart-large-object creation function (such as mi_lo_create()) to provide the maximum size as a user-supplied storage characteristic for a new smart large object.
For more information about the maximum size of a smart large object or on how to use the mi_lo_specset_maxbytes() function, see the HCL OneDB™ DataBlade® API Programmer's Guide.
Return values
- MI_OK
- The function was successful.
- MI_ERROR
- The function was not successful.