The ifx_lo_read() function

The ifx_lo_read() function reads data from an open smart large object.

Syntax

ifx_lo_read(lofd, buf)

Arguments

The function accepts the following arguments.
Argument Type Use Description
lofd SQL_INTEGER Input Smart-large-object file descriptor
buf SQL_CHAR Output Pointer to a character buffer into which the function will read the data

Usage

The ifx_lo_read() function reads data from an open smart large object. The read begins at the current seek position for lofd. You can call ifx_lo_tell() to obtain the current seek position.

The ifx_lo_read() function reads cbValueMax bytes of data. cbValueMax is an input argument for SQLBindParameter() and SQLBindCol(). The size of buf or cbValueMax cannot exceed 2 gigabytes. To read a smart large object that is larger than 2 gigabytes, read it in 2-gigabyte chunks. The ifx_lo_read() function reads this data into the user-defined buffer to which buf points.

If SQLBindParameter() or SQLBindCol() returns SQL_SUCCESS, then pcbValue, which is an argument for each of these functions, contains the number of bytes that the function read from the smart large object. If SQLBindParameter() or SQLBindCol() returns SQL_SUCCESS_WITH_INFO, then pcbValue contains the number of bytes that are available to read from the smart large object.