Home
Extending HCL OneDB™Beyond standard relational database objects, HCL OneDB™ can be extended to handle specialized data types, access methods, routines, and other objects. HCL OneDB™ includes many built-in extensions that are fully integrated in the database server. HCL OneDB™ also provides DataBlade® modules, which are packages of extended database objects for a particular purpose and that are installed separately from the database server. Alternatively, you can create your own user-defined objects for HCL OneDB™.
Creating extensionsYou can create user-defined data types, routines, access methods, and other database objects to suit your needs. You can use application programming interfaces to write user-defined routines and applications that access data in HCL OneDB™ databases.
DataBlade® API Function ReferenceThe HCL OneDB™ DataBlade® API Function Reference describes the DataBlade® API functions and the subset of functions that the DataBlade® API supports.
Function descriptionsThis section gives comprehensive reference information about the functions that are valid within DataBlade® API modules. It lists the function descriptions in alphabetical order, with syntax, usage information, and return values for the functions.
The mi_lo_specget_maxbytes() functionThe mi_lo_specget_maxbytes() accessor function obtains the maximum size of a smart large object (in bytes) from an LO-specification structure.

The mi_lo_specget_maxbytes() function

The mi_lo_specget_maxbytes() accessor function obtains the maximum size of a smart large object (in bytes) from an LO-specification structure.

Syntax

mi_integer mi_lo_specget_maxbytes(LO_spec, maxbytes)
   MI_LO_SPEC *LO_spec;
   mi_int8 *maxbytes;

LO_spec: A pointer to the LO-specification structure from which to obtain the maximum size.
maxbytes: A pointer to an eight-byte integer (mi_int8) value into which mi_lo_specget_maxbytes() puts the maximum size, in bytes, of the smart large object.


Valid in client LIBMI application?	Valid in user-defined routine?
Yes	Yes

Usage

The mi_lo_specget_maxbytes() function is the LO-specification accessor function that returns the maximum size from a set of storage characteristics. The smart-large-object optimizer does not allow the size of a smart large object to exceed the maxbytes value.

Important: Before you call mi_lo_specget_maxbytes(), 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_specget_maxbytes() function sets the maximum size in an LO-specification structure.

The mi_lo_specget_maxbytes() function obtains the current value for the maximum size from the LO-specification structure that LO_spec references.

For more information about the maximum size of a smart large object or about how to use the mi_lo_specget_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; the LO-specification structure might be invalid.