IBM Books

Image, Audio, and Video Extenders Administration and Programming

DBvIsColumnEnabled


Image Audio Video
    X

Determines whether a column has been enabled for video (DB2Video 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
dmbvideo.lib libdmbvideo.a (AIX)

libdmbvideo.sl (HP-UX)

libdmbvideo.so (Solaris)

Include file

dmbvideo.h

Syntax

long DBvIsColumnEnabled(
      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 numerical 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_RC_NOT_CONNECTED
Application does not have valid connection to a database.

Examples

Determine if the video column in the employee table is enabled for video:

#include <dmbvideo.h>
 
rc = DBvIsColumnEnabled("employee",
       "video", &status);


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