The mi_lo_specget_extsz() function
The mi_lo_specget_extsz() function obtains from an LO-specification structure the allocation extent size, in kilobytes, of a smart large object.
Syntax
mi_integer mi_lo_specget_extsz(LO_spec)
MI_LO_SPEC *LO_spec;
- LO_spec
- A pointer to the LO-specification structure from which to obtain the extent size.
Valid in client LIBMI application? | Valid in user-defined routine? |
---|---|
Yes | Yes |
Usage
The mi_lo_specget_extsz() function
is the LO-specification accessor function that returns the allocation
extent size from a set of storage characteristics. The extsz value
specifies the size, in kilobytes, of the allocation extents to be
allocated for the smart large object when the smart-large-object optimizer
writes beyond the end of the current extent.
Important: Before
you call mi_lo_specget_extsz(), you must put storage
characteristics into an LO-specification structure.
You
can use any of the following functions to initialize the LO-specification
structure:
- The mi_lo_colinfo_by_ids() or mi_lo_colinfo_by_name() function puts storage characteristics that are associated with a particular CLOB or BLOB column in an LO-specification structure.
- The mi_lo_stat_cspec() function puts storage characteristics of an existing smart large object in an LO-specification.
- The mi_lo_specset_extsz() function sets the extent size in an LO-specification structure.
The mi_lo_specget_extsz() function obtains the current value for the extent size from the LO-specification structure that LO_spec references.
For more information about the allocation extent size of a smart large object or on how to use the mi_lo_specget_extsz() function, see the HCL OneDB™ DataBlade® API Programmer's Guide.
Return values
- >=0
- The number of kilobytes in the extent size from the LO-specification structure that LO_spec references.
- MI_ERROR
- The function was not successful; the LO-specification structure might be invalid.