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

mi_lo_specset_maxbytes()

The mi_lo_specset_maxbytes() function sets the maximum number of bytes allowed for a smart large object.

Syntax

Usage

The mi_lo_specset_maxbytes() function is the LO-specification accessor function that sets the maximum size of a new smart large object. When you set a maximum size, the smart-large-object optimizer does not allow the size of a smart large object to exceed the maxbytes value. Most applications do not need to specify a maximum size.

Important: Before you call mi_lo_specset_maxbytes(), you must initialize an LO-
specification structure.

Once you set the maximum size in an LO-specification structure, you pass this structure to a smart-large-object creation function (such as mi_lo_create()) to provide the maximum size as a user-supplied storage characteristic for a new 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_maxbytes().

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




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