IBM Books

Image, Audio, and Video Extenders Administration and Programming

DBiGetReferencedFiles


Image Audio Video
X    

Returns the names of files that are referred to in image columns of user tables. If a file is inaccessible (for example, its file name cannot be resolved using environment variable specifications), the file name is preceded with an asterisk. This API does not use the FILENAME field of the FILEREF data structure, and therefore sets it to NULL. The application must be connected to a database before calling this API.

It is important that you free up the resources that are allocated by this API after calling it. Specifically, you must free up the filelist data structure.

Authorization

SELECT privilege on enabled image columns in all searched user tables and associated administrative support tables

Library file
OS/2 and Windows AIX, HP-UX, and Solaris
dmbimage.lib libdmbimage.a (AIX)

libdmbimage.sl (HP-UX)

libdmbimage.so (Solaris)

Include file

dmbimage.h

Syntax

long DBiGetReferencedFiles(
      char *tableName,
      long *count,
      FILEREF *(*fileList)
      );

Parameters

tableName (in)
A qualified, unqualified , or null table name. If a table name is specified, that table is searched for references to files. If a null value is specified, all tables owned by the current user ID are searched.

count (out)
The number of entries in the output list.

fileList (out)
A list of files that are referred to in the table.

Error codes

MMDB_SUCCESS
API call processed successfully.

MMDB_RC_NOT_CONNECTED
Application does not have valid connection to a database.

MMDB_RC_MALLOC
System cannot allocate memory to return the results.

Examples

List all files that are referred to in image columns in the employee table:

#include <dmbimage.h>
long idx;
 
rc = DBiGetReferencedFiles("employee",
       &count, &filelist);


[ Top of Page | Previous Page | Next Page | Table of Contents | Index ]