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

The mi_lo_filename() function constructs a filename for smart-large-object data based on an LO handle and a filename specification.

Syntax

#include "milo.h"

...
const char *mi_lo_filename(conn, LO_hdl, fname_spec)

		MI_CONNECTION *conn;

		MI_LO_HANDLE *LO_hdl;

		const char *fname_spec; 


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

LO_hdl
is a pointer to a valid LO handle.

fname_spec
is a specification for the destination file pathname. It can include wildcard characters.







 



Valid in Client Application?

Valid in Server Routine?

Yes
Yes

Usage

The mi_lo_filename() function generates a filename from the fname_spec argument that you provide. This function uses a template to specify the exact format of the result. Use the mi_lo_filename() function to determine the filename that the mi_lo_to_file() function would create for its fname_spec argument.

By default, the mi_lo_to_file() function generates a filename of the form:

fname.hex_id

However, you can specify wildcards in the fname_spec argument that can change this default filename. You can use these wildcards in the fname_spec argument of mi_lo_filename() to see what filename these wildcards generate. For more information on the wildcards that are valid in the fname_spec argument, see the description of the mi_lo_to_file() function on page 12-358.

You are responsible for freeing the memory that the return value occupies.

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

Return Values

char *
The character string that is the filename that the mi_lo_to_file() function would generate.

NULL
The function was not successful.

DataBlade API Programmer's ManualChapter 12: DataBlade API Function Descriptions Home Contents Index Master Index New Book

mi_lo_filename()

Syntax

Usage

Return Values char * The character string that is the filename that the mi_lo_to_file() function would generate. NULL 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

char *
The character string that is the filename that the mi_lo_to_file() function would generate.

NULL
The function was not successful.