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

mi_lo_specget_flags()

The mi_lo_specget_flags() function obtains from an LO-specification structure the attributes flag for a smart large object.

Syntax

Usage

The mi_lo_specget_flags() function is the LO-specification accessor function that returns the attributes flag from a set of storage characteristics. The attributes flag provides the following information about a smart large object:

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

Important: Before you call mi_lo_specget_flags(), 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_flags() function gets the current value for the attributes flag from the LO-specification structure that LO_spec references.

Return Values

>=0

The bitmask for the attributes flags 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_flags(), and mi_lo_stat_cspec().

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




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