dbisopt

Description

Check the status of a server or DB-Library option.

Syntax

DBBOOL dbisopt(dbproc, option, param)
 
DBPROCESS   *dbproc;
int                       option;
char                  *param;

Parameters

dbproc

A pointer to the DBPROCESS structure that provides the connection for a particular front-end/server process. It contains all the information that DB-Library uses to manage communications and data between the front end and server. Unlike in the functions dbsetopt and dbclropt, dbproc cannot be NULL here.

option

The option to be checked. See Options for the list of options.

param

Certain options take parameters. The DBOFFSET option, for example, takes as a parameter the SQL construct for which offsets are to be returned. Options lists those options that take parameters. If an option does not take a parameter, param must be NULL.

If the option you are checking takes a parameter but there can be only one instance of the option, dbisopt ignores the param argument. For example, dbisopt ignores the value of param when checking the DBBUFFER option, because row buffering can have only one setting at a time. On the other hand, the DBOFFSET option can have several settings, each with a different parameter. It may have been set twice—to look for offsets to select statements and for offsets to order by clauses. In that case, dbisopt needs the param argument to determine whether to check the select offset or the order by offset.

Returns

TRUE” or “FALSE”.

Usage

See also

dbclropt, dbsetopt, Options