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

The mi_lo_to_buffer() function copies a specified number of bytes from a smart large object to a user-defined buffer.

Syntax

mi_integer mi_lo_to_buffer(conn, LO_hdl, size, buf_ptr)

		MI_CONNECTION *conn;

		MI_LO_HANDLE *LO_hdl;

		mi_integer size;
		char **buf_ptr; 


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

LO_hdl
is the LO handle for the smart large object from which you want to copy the data.

size
is an integer number of bytes to copy from the smart large object.

buf_ptr
is a doubly indirected pointer to a user-defined buffer to which you want to copy the data.







 



Valid in Client Application?

Valid in Server Routine?

Yes
Yes

Usage

The mi_lo_to_buffer() function copies up to size bytes from the smart large object that the LO_hdl LO handle references. The read operation from the smart large object starts at a zero-byte offset. This function allows you to read data from a smart large object without opening the smart large object.

If the smart large object is smaller than the size value, mi_lo_to_buffer() copies only the number of bytes in the smart large object. If the smart large object contains more than size bytes, the mi_lo_to_buffer() function copies only size bytes to the user-defined buffer.

When *buf_ptr points to NULL, mi_lo_to_buffer() allocates the memory for the buffer. Otherwise, the function assumes that you have allocated memory that buf_ptr references.

Return Values

>=0
The number of bytes copied from the smart large object to the user-defined buffer that buf_ptr references.

MI_ERROR
The function was not successful.

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

mi_lo_to_buffer()

Syntax

Usage

Return Values >=0 The number of bytes copied from the smart large object to the user-defined buffer that buf_ptr references. MI_ERROR 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 copied from the smart large object to the user-defined buffer that buf_ptr references.

MI_ERROR
The function was not successful.