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

mi_lo_specget_estbytes()

The mi_lo_specget_estbytes() function gets from an LO-specification structure the estimated size, in bytes, of a smart large object.

Syntax

Usage

The mi_lo_specget_estbytes() function is the LO-specification accessor function that returns the estimated size from a set of storage characteristics. The estbytes value is the estimated final size, in bytes, of the smart large object. This estimate is an optimization hint for the smart-large-object optimizer.

Important: Before you call mi_lo_specget_estbytes(), 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_specget_estbytes() function gets the current value for the estimated size from the LO-specification structure that LO_spec references.

Return Values

MI_OK

The function was successful.

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_estbytes(), and mi_lo_stat_cspec().

In Chapter 3, "Handling Smart Large Objects," see "Storage Characteristics" for more information on the estimated 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_estbytes() function.




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