Home | Previous Page | Next Page   Function Descriptions >

mi_lo_specset_sbspace( )

The mi_lo_specset_sbspace( ) function sets the sbspace name of a smart large object in an LO-specification structure.

Syntax

mi_integer mi_lo_specset_sbspace(LO_spec, sbspace_name)
   MI_LO_SPEC *LO_spec;
   const char *sbspace_name;
LO_spec
is a pointer to the LO-specification structure in which to save the sbspace name.
sbspace_name
is a pointer to the sbspace name for the smart large object.
Valid in Client LIBMI Application? Valid in User-Defined Routine?
Yes Yes

Usage

The mi_lo_specset_sbspace( ) function is the LO-specification accessor function that sets the sbspace name for a new smart large object. The name of the sbspace can be at most 18 characters long and must be null terminated.

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

When you set the sbspace name with mi_lo_specset_sbspace( ), you override any column-level or system-specified sbspace name 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 sbspace name as a user-supplied storage characteristic for a new smart large object.

Return Values

MI_OK
indicates that the function was successful.
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_spec_free( ), mi_lo_spec_init( ), and mi_lo_specget_sbspace( ).

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

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