IBM Books

Image, Audio, and Video Extenders Administration and Programming

DBiIsColumnEnabled


Image Audio Video
X    

Determines whether a column has been enabled for images (DB2Image data). The application must be connected to a database before calling this API.

Authorization

SYSADM, DBADM, table owner, or SELECT privilege on the user table

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 DBiIsColumnEnabled(
      char *tableName,
      char *colName,
      short *status
      );

Parameters

tableName (in)
A qualified or unqualified table name.

colName (in)
The name of a column.

status (out)
Indicates whether the column is enabled. This parameter returns a numeric value. The extender also returns a constant that indicates the status. The values and constants are:

1
MMDB_IS_ENABLED

0
MMDB_IS_NOT_ENABLED

-1
MMDB_INVALID_DATATYPE

Error codes

MMDB_SUCCESS
API call processed successfully.

MMDB_RC_NO_AUTH
Caller does not have the proper access authority.

MMDB_WARN_ALREADY_ENABLED
Column is already enabled.

MMDB_RC_NOT_CONNECTED
Application does not have valid connection to a database.

Examples

Determine if the picture column in the employee table is enabled for images:

#include <dmbimage.h>
 
rc = DBiIsColumnEnabled("employee",
       "picture", &status);


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