Home | Previous Page | Next Page   Function Descriptions >

mi_lo_specget_maxbytes( )

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
is a pointer to the LO-specification structure from which to obtain the maximum size.
maxbytes
is 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_specget_maxbytes( ) function obtains the current value for the maximum size from the LO-specification structure that LO_spec references.

Return Values

MI_OK
indicates that the function was successful.
MI_ERROR
indicates that the function was not successful; the LO-specification structure might be invalid.

Related Topics

See also the descriptions of mi_lo_colinfo_by_ids( ), mi_lo_colinfo_by_name( ), mi_lo_spec_free( ), mi_lo_spec_init( ), mi_lo_specset_maxbytes( ), and mi_lo_stat_cspec( ).

For more information on the maximum size of a smart large object or on how to use the mi_lo_specget_maxbytes( ) function, see the IBM Informix: DataBlade API Programmer's Guide.

Home | [ Top of Page | Previous Page | Next Page | Contents | Index ]