Informix DataBlade API Programmer's Manual DataBlade API Function Descriptions

The mi_file_read() function reads a specified number of bytes from an open operating-system file into a buffer.

mi_integer mi_file_read(fd, buf, nbytes)

mi_integer fd;

char *buf;

mi_integer nbytes;

fd	is the file descriptor for the file from which to read the data. It is obtained by a previous call to mi_file_open().
buf	is a pointer to a user-allocated character buffer that contains the data that mi_file_read() reads from the file.
nbytes	is the maximum number of bytes to read from the buf character buffer.

Valid in Client LIBMI Application?	Valid in User-Defined Routine?
Yes	Yes

The mi_file_read() function reads nbytes bytes of data from the file that the fd file descriptor identifies. The read begins at the current seek position for fd. You can use the mi_file_tell() function to obtain the current seek position. The function reads this data into the user-allocated buffer that buf references.

This function can access files on the server computer from a C UDR.

The mi_file_read() function does not throw an MI_Exception event when it encounters a runtime error. Therefore, it does not cause callbacks to be invoked.

See the descriptions of the following functions: mi_file_open(), mi_file_seek(), mi_file_tell(), and mi_file_write().