dbisopt

Checks the status of a SQL Server or DB-Library option.

Syntax

BOOL dbisopt (
PDBPROCESS dbproc,
INT option,
LPCSTR param );

where

dbproc

Is the DBPROCESS structure that is the handle for a particular workstation/ SQL Server process. It contains all the information that DB-Library uses to manage communications and data between the workstation and SQL Server. Unlike the functions dbsetopt and dbclropt, dbproc cannot be NULL here.

option

Is the option to be checked.

param

Is the option parameter. Certain options take parameters. If an option does not take a parameter, param is ignored. If an option does take a parameter, param is ignored for all options except DBOFFSET and DBSTAT.

The DBOFFSET and DBSTAT options can have several settings, each with a different parameter. In these cases, dbisopt needs a valid param to determine which option parameter to check.

For a list of options that take parameters, see DB-Library Options.

Returns

TRUE or FALSE.

Remarks

Although SQL Server options can be set and cleared directly through SQL, the application should use dbsetopt and dbclropt to set and clear options. This provides a uniform interface for setting both SQL Server and DB-Library options. It also allows the application to use the dbisopt function to check the status of an option.

For a list of each option and its default status, see DB-Library Options.

See Also

dbclropt, dbsetopt; Bulk-Copy Functions, and DB-Library Options