INFORMIX
DataBlade API Programmer's Manual
Chapter 12: DataBlade API Function Descriptions
Home Contents Index Master Index New Book

mi_lo_specset_extsz()

The mi_lo_specset_extsz() function sets the allocation extent size for a smart large object.

Syntax

Usage

The mi_lo_specset_extsz() function is the LO-specification accessor function that sets the allocation extent size for a new smart large object. The extsz value specifies the size 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_specset_extsz(), you must initialize an LO-
specification structure.

When you set the extent size with mi_lo_specset_extsz(), you override any column-level or system-specified extent size in the LO-specification structure. You then pass this LO-specification structure to a smart-large-object creation function (such as mi_lo_create()) to provide the extent size as a user-supplied storage characteristic for a new smart large object.

The smart-large-object optimizer attempts to optimize the extent size based on past operations on the smart large object and other storage characteristics (such as maximum bytes) that it obtains from the storage-characteristics hierarchy. Most applications can use this generated extent size.

Important: Do not change the system-specified extent size unless your application encounters severe storage fragmentation. For such applications, make sure that you know exactly the number of bytes by which to extend the smart large object.

Return Values

MI_OK

The function was successful.

MI_ERROR

The function was not successful.

Related Topics

See the descriptions of the following functions: mi_lo_copy(), mi_lo_create(), mi_lo_expand(), mi_lo_from_file(), mi_lo_spec_free(), mi_lo_spec_init(), and mi_lo_specget_extsz().

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_specset_extsz() function.




DataBlade API Programmer's Manual, version 9.1
Copyright © 1998, Informix Software, Inc. All rights reserved.