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

The mi_lo_write() function writes a specified number of bytes of data to an open smart large object.

Syntax

#include "milo.h"

...
mi_integer mi_lo_write(conn, LO_fd, buf, nbytes)

		MI_CONNECTION *conn;

		MI_LO_FD LO_fd;

		const char *buf;

		mi_integer nbytes; 


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

LO_fd
is an LO file descriptor for the smart large object to which to write.

buf
is a pointer to a user-allocated character buffer of at least nbyte bytes that contains the data to be written to the smart large object.

nbytes
is the number of bytes to write to the smart large object. This value cannot exceed 2 gigabytes.







 



Valid in Client Application?

Valid in Server Routine?

Yes
Yes

Usage

The mi_lo_write() function writes nbytes of data to the smart large object that the LO_fd file descriptor identifies. The write begins at the current LO seek position for LO_fd. You can use the mi_lo_tell() function to obtain the current LO seek position.

The function obtains the data from the user-allocated buffer that buf references. The buf buffer must be less than 2 gigabytes in size.

If the database server writes less than nbytes of data to the smart large object, the mi_lo_write() function returns the number of bytes that it wrote and raises an exception. This condition can occur when the sbspace runs out of space.

To perform a seek operation before a write operation, use the function mi_lo_writewithseek().

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

Return Values

>=0
The number of bytes that the function has written from the buf character buffer to open the smart large object.

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

Syntax

Usage

Return Values >=0 The number of bytes that the function has written from the buf character buffer to open the smart large object. 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 that the function has written from the buf character buffer to open the smart large object.

MI_ERROR
The function was not successful.