Home | Previous Page | Next Page   Function Descriptions >

mi_lo_specget_def_open_flags( )

The mi_lo_specget_def_open_flags( ) function obtains from an LO-specification structure the default open-mode flag for a smart large object.

Syntax

mi_integer mi_lo_specget_def_open(LO_spec)
   MI_LO_SPEC *LO_spec;
LO_spec
is a pointer to the LO-specification structure from which to obtain the default open flags.
Valid in Client LIBMI Application? Valid in User-Defined Routine?
Yes Yes

Usage

The mi_lo_specget_def_open_flags( ) function obtains the current value for the default open-mode flag from the LO-specification structure that LO_spec references. This default open-mode flag is the bit mask that indicates which open mode the mi_lo_open( ) function uses when it opens the smart large object but does not specify an open-mode flag. To override the default open-mode flag, you can specify an open mode as an argument to mi_lo_open( ).

Important:
Before you call mi_lo_specget_def_open_flags( ), you must put storage characteristics into an LO-specification structure.

You can use any of the following functions to initialize the LO-specification structure:

Return Values

MI_OK
indicates that the bit-mask value of the default open flags for the smart large object that LO_spec references.
MI_ERROR
indicates that the function was not successful.

Related Topics

See also the descriptions of mi_lo_copy( ), mi_lo_create( ), mi_lo_from_file( ), mi_lo_open( ), mi_lo_spec_free( ), mi_lo_spec_init( ), and mi_lo_specset_def_open_flags( ).

For more information on the default open mode of a smart large object or on how to use the mi_lo_specget_def_open_flags( ) function, see the IBM Informix: DataBlade API Programmer's Guide.

Home | [ Top of Page | Previous Page | Next Page | Contents | Index ]