DataBlade API Programmer's Manual

DataBlade API Programmer's Manual
Chapter 12: DataBlade API Function Descriptions

Home Contents Index Master Index New Book

mi_lo_specget_extsz()

The mi_lo_specget_extsz() function gets from an LO-specification structure the allocation extent size, in kilobytes, of a smart large object.

Syntax

#include "milo.h"

...
mi_integer mi_lo_specget_extsz(LO_spec)

		MI_LO_SPEC *LO_spec; 


LO_spec
is a pointer to the LO-specification structure from which to obtain the extent size.







 



Valid in Client Application?

Valid in Server 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 to initialize the LO-specification structure:

The mi_lo_colinfo_by_ids() or mi_lo_colinfo_by_name() function put 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 gets the current value for the extent size from the LO-specification structure that LO_spec references.

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.

Related Topics

See the descriptions of the following functions: mi_lo_colinfo_by_ids(), mi_lo_colinfo_by_name(), mi_lo_spec_free(), mi_lo_spec_init(), mi_lo_specset_extsz(), and mi_lo_stat_cspec().

In Chapter 3, "Handling Smart Large Objects," see "Storage Characteristics" for more information on the allocation extent size of a smart large object. See "The LO-Specification Structure", and "Defining User-Specified Storage Characteristics" for information on how to use the mi_lo_specget_extsz() function.