Home | Previous Page | Next Page   Function Descriptions >

mi_lo_alter( )

The mi_lo_alter( ) function alters the storage characteristics of an existing smart large object.

Syntax

mi_integer mi_lo_alter(conn, LO_hdl, LO_spec)
   MI_CONNECTION *conn;
   MI_LO_HANDLE *LO_hdl;
   MI_LO_SPEC *LO_spec;
conn
is one of the following connection values:

A pointer to a connection descriptor established by a previous call to mi_open( ), mi_server_connect( ), or mi_server_reconnect( )

A NULL-valued pointer (database server only)

LO_hdl
is a pointer to an LO handle.
LO_spec
is a pointer to an LO-specification structure.
Valid in Client LIBMI Application? Valid in User-Defined Routine?
Yes Yes

Usage

The mi_lo_alter( ) function updates the storage characteristics of an existing smart large object with the characteristics in the LO-specification structure that LO_spec references. With mi_lo_alter( ), you can change only the following storage characteristics:

The function obtains an exclusive lock for the entire smart large object before it proceeds with the update. It holds this lock until the update completes.

Server Only

In a C UDR, the mi_lo_alter( ) function does not need a connection descriptor to execute. If your UDR does not need a valid connection for other operations, you can specify a NULL-valued pointer for the conn parameter to establish a NULL connection. For information on the advantages of a NULL connection, see the IBM Informix: DataBlade API Programmer's Guide.

End of Server Only

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_spec_init( ), mi_lo_colinfo_by_name( ), and mi_lo_colinfo_by_ids( ).

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