mi_integer mi_lo_from_file_by_lofd(conn, LO_fd, fname_spec, open_mode,
   offset, amount)
   MI_CONNECTION *conn;
   MI_LO_FD LO_fd;
   const char *fname_spec;
   mi_integer open_mode;
   mi_integer offset;
   mi_integer amount;

conn

is one of the following connection values:

A pointer to a connection descriptor established by a previous call to mi_open( ), mi_server_connect( ), or mi_server_reconnect( )

A NULL-valued pointer (database server only)

LO_fd

is a file descriptor for an existing smart large object

fname_spec

is the path to the operating-system file to copy into a smart large object.

open_mode

is an integer bitmask to indicate how to open the operating-system file and where this file is located. For a list of valid file-mode constants, see the table in the following "Usage" section.

offset

is the point to begin reading in the file. The offset value is the number of bytes from the beginning of the file, starting at 0.

amount

is the amount of the file to read, starting at the offset. An amount value of -1 means read to the end of the file.

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

The mi_lo_from_file_by_lofd( ) function enables you to write to a smart large object that is already open. This function provides more flexibility than mi_lo_from_file( ), in the following ways:

• You can position the LO file descriptor anywhere before the operation.
• You can copy multiple files to a single smart large object.

To include environment variables in the fname_spec path, use the following syntax:

$ENV_VAR

You must set these environment variables in the database server environment, before the database server starts.

The mi_lo_from_file_by_lofd( ) function can create the target files on either the server or the client computer. The file-mode flag values for the open_mode argument indicate the location of the file to copy and the access mode of the source file. Valid values include the following file-mode constants.

File-Mode Constant

Purpose

MI_O_EXCL

Open the file only if fname_spec does not exist.

MI_O_TRUNC

Zero out the input file before reading it.

MI_O_APPEND

Allow appending to the end of the file. (This function does not write to the source file.)

MI_O_RDWR

Open the file in read/write mode. (This function does not write to the source file.)

MI_O_RDONLY

Open the file in read-only mode.

MI_O_TEXT

Process the file as text (not binary). (Binary is used if you do not specify MI_O_TEXT.)

MI_O_SERVER_FILE

The fname_spec file is on the server computer.

MI_O_CLIENT_FILE

The fname_spec file is on the client computer.

The default open_mode value is:

MI_O_RDONLY | MI_O_CLIENT_FILE

MI_OK

indicates that the function was successful.

MI_ERROR

indicates that the function was not successful.

See also the descriptions of mi_lo_create( ), mi_lo_spec_init( ), mi_lo_from_buffer( ), mi_lo_from_file( ), and mi_lo_to_file( ).