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

mi_lo_specset_flags()

The mi_lo_specset_flags() function sets the attributes flag for a smart large object.

Syntax

Usage

The mi_lo_specset_flags() function is the LO-specification accessor function that sets the attributes flag for a new smart large object. The attributes flag provide the following information about a smart large object:

Constants for these attributes are masked together into the single attributes-flag value. Therefore, to set a particular attribute, you must use the bitwise OR operator (|) to mask the attributes flag, as the following code fragment shows:

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

When you set the attributes flag with mi_lo_specset_flags(), you override any column-level or system-specified attributes flag 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 attributes flag 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_flags().

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




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