DataBlade API Programmer's Manual

DataBlade API Programmer's Manual
Chapter 12: DataBlade API Function Descriptions

Home Contents Index Master Index New Book

mi_lo_invalidate()

The mi_lo_invalidate() function marks the LO handle as invalid.

Syntax

#include "milo.h"

...
mi_integer mi_lo_invalidate(conn, LO_hdl)

		MI_CONNECTION *conn;

		MI_LO_HANDLE *LO_hdl; 


conn
is a pointer to the connection descriptor that a previous call to mi_open() or mi_server_connect() established.

LO_hdl
is a pointer to the LO handle to invalidate.







 



Valid in Client Application?

Valid in Server Routine?

Yes
Yes

Usage

The mi_lo_validate() marks as invalid the LO handle that LO_hdl references. You can use the mi_lo_invalidate() function in the support function of an opaque data type to make smart large objects invalid. It allows these support functions to invalidate an LO handle explicitly before it is stored. You might want to mark an LO handle as invalid to indicate that it is not active.

If mi_lo_invalidate() fails due to an invalid connection, callbacks are invoked. If it fails due to an illegal handle, callbacks are not invoked.

Return Values

MI_OK
The function was successful; the LO handle was successfully invalidated.

MI_ERROR
The function was not successful; the connection was invalid or the handle was illegal.

DataBlade API Programmer's ManualChapter 12: DataBlade API Function Descriptions Home Contents Index Master Index New Book

mi_lo_invalidate()

Syntax

Usage

Return Values MI_OK The function was successful; the LO handle was successfully invalidated. MI_ERROR The function was not successful; the connection was invalid or the handle was illegal.

Related Topics

DataBlade API Programmer's Manual
Chapter 12: DataBlade API Function Descriptions

Home Contents Index Master Index New Book

Return Values

MI_OK
The function was successful; the LO handle was successfully invalidated.

MI_ERROR
The function was not successful; the connection was invalid or the handle was illegal.