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

The mi_lo_lolist_create() function converts an array of LO handles into an MI_LO_LIST structure.

Syntax

#include "milo.h"

...
mi_integer mi_lo_lolist_create(conn, LOhdl_cnt, LO_hdls, LO_list)

		MI_CONNECTION *conn;

		mi_integer LO_hdlcnt;

		MI_LO_HANDLE **LO_hdls;

		MI_LO_LIST **LO_list ; 


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

LOhdl_cnt
is the number of LO handles in the LO_hdls array.

LO_hdls
is a pointer to an array of LO handles that mi_lo_lolist_create() converts.

LO_list
is a pointer to the MI_LO_LIST structure that mi_lo_lolist_create() creates.







 



Valid in Client Application?

Valid in Server Routine?

No
Yes

Usage

The mi_lo_lolist_create() function populates an MI_LO_LIST structure with LO handles from the specified LO_hdls array. The MI_LO_LIST structure allows user-defined routines to pass an array of LO handles to and from the database server. The function handles memory allocation for the MI_LO_LIST structure as follows:

When the *LO_list value points to NULL, this function allocates an MI_LO_LIST structure.
When *LO_list does not point to NULL, the mi_lo_lolist_create() function assumes that *LO_list points to memory that has already been allocated via a previous call to mi_lo_lolist_create().

The mi_lo_lolist_create() function then initializes the MI_LO_LIST structure with the LO handles, which LO_hdls indicates. It converts the number of LO handles that the LOhdl_cnt argument specifies.

The mi_lo_lolist_create() function is useful in an lohandles() support function of an opaque data type. It converts an array of LO handles to the flat MI_LO_LIST structure that the lohandles() support function returns.

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

Home Contents Index Master Index New Book

mi_lo_lolist_create()

Syntax

Usage

Return Values

>=0
The number of bytes of the MI_LO_LIST structure.

0
The function was not successful.

Related Topics

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

mi_lo_lolist_create()

Syntax

Usage

Return Values >=0 The number of bytes of the MI_LO_LIST structure. 0 The function was not successful.

Related Topics

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

Home Contents Index Master Index New Book

Return Values

>=0
The number of bytes of the MI_LO_LIST structure.

0
The function was not successful.