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_validate()

The mi_lo_validate() function checks whether a given LO handle is valid.

Syntax

#include "milo.h"

...
mi_integer mi_lo_validate(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 validate.







 



Valid in Client Application?

Valid in Server Routine?

Yes
Yes

Usage

The mi_lo_validate() checks whether the LO handle that LO_hdl references is valid. An LO handle might be invalid for any of the following reasons:

The memory address is invalid or NULL.
The LO handle contains invalid reference data because:
- It was never set to a valid value.
- It was explicitly invalidated with the mi_lo_invalidate() function.

You can use the mi_lo_validate() function in the support function of an opaque data type that contains smart large objects. In the lohandles() support function, this function can determine unambiguously which LO handles are valid for the given instance of the opaque type.

If mi_lo_validate() fails due to an invalid connection, callbacks are invoked.

Return Values

0
The LO handle that LO_hdl references is valid.

>0
The LO handle that LO_hdl references is invalid.

MI_ERROR
The connection was invalid.

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

mi_lo_validate()

Syntax

Usage

Return Values 0 The LO handle that LO_hdl references is valid. >0 The LO handle that LO_hdl references is invalid. MI_ERROR The connection was invalid.

Related Topics

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

Home Contents Index Master Index New Book

Return Values

0
The LO handle that LO_hdl references is valid.

>0
The LO handle that LO_hdl references is invalid.

MI_ERROR
The connection was invalid.