The lld_to_client() function

This function copies a large object to a client file.

Syntax

API

MI_ROW* lld_to_client(conn, src, dest, error);
   MI_CONNECTION*               conn,
   MI_ROW*                      src,
   mi_string*                   dest,
   mi_integer*                  error

ESQL/C

ifx_collection_t* lld_to_client (src, dest, error);
   EXEC SQL BEGIN DECLARE SECTION;
      PARAMETER ROW src;
   EXEC SQL END DECLARE SECTION;
   char* dest;
   int* error;

SQL

LLD_ToClient (src LLD_Locator, dest LVARCHAR)
   RETURNS BOOLEAN;

conn: The connection descriptor established by a previous call to the mi_open() or mi_server_connect() functions. This parameter is for the API interface only. In the ESQL/C and SQL versions of this function, you must already be connected to a server.
src: A pointer to the lld_locator row that identifies the source large object.
dest: A pointer to the destination path name. If the destination file does not exist, it is created.
error: An error code. The SQL version of this function does not have an error parameter.

Usage

This function copies an existing large object to a client file. It creates the client file if it does not already exist.

Return codes

For an API function, returns MI_OK if the function succeeds and MI_ERROR if it fails.

For an ESQL/C function, returns 0 if the function succeeds and -1 if the function fails.

Context

The lld_open_client() function