Informix DataBlade API Programmer's Manual DataBlade API Function Descriptions

The mi_lo_close() function closes an open smart large object.

mi_integer mi_lo_close(conn, LO_fd)

MI_CONNECTION *conn;

MI_LO_FD LO_fd;

conn	is a pointer to the connection descriptor that a previous call to mi_open(), mi_server_connect(), or mi_server_reconnect() has established.
LO_fd	is an LO file descriptor of the smart large object to close.

Valid in Client LIBMI Application?	Valid in User-Defined Routine?
Yes	Yes

The mi_lo_close() function closes the smart large object that is associated with the LO file descriptor, LO_fd, then frees this file descriptor. This function is the destructor function for an LO file descriptor. A call to the mi_lo_open(), mi_lo_copy(), mi_lo_create(), mi_lo_expand(), or mi_lo_from_file() function returns an LO file descriptor for a smart large object. Once you free a LO file descriptor, it can be reused for another smart large object. Any open smart large objects that you do not explicitly close are automatically closed when the connection closes (when the client connection terminates or the C user-defined routine completes).

When the mi_lo_close() function closes a smart large object, the database server attempts to unlock a locked smart large object if it has a share-mode or update-mode lock. For exclusive locks, the database server does not permit the release of the lock until the end of the transaction.

Tip: The mi_lo_close() function replaces the mi_large_object_close() function, which Informix supports for backward compatibility only. Use mi_lo_close() for all new DataBlade API routines.

Return Values

MI_OK	indicates that the function was successful.
MI_ERROR	indicates that the function was not successful; the session is bad, or an argument is invalid.

See the descriptions of the following functions: mi_lo_copy(), mi_lo_create(), mi_lo_expand(), mi_lo_from_file(), and mi_lo_open().

For more information, see Smart-Large-Object Locks and Closing a Smart Large Object.