SQLGetStmtOption() - Return current setting of a statement option

SQLGetStmtOption() is a deprecated function and is replaced by SQLGetStmtAttr().

ODBC specifications for SQLGetStmtOption()

Table 1. SQLGetStmtOption() specifications
ODBC specification level In X/Open CLI CAE specification? In ISO CLI specification?
1.0 (Deprecated) Yes No

Syntax

SQLRETURN   SQLGetStmtOption (SQLHSTMT          hstmt,
                              SQLUSMALLINT      fOption,
                              SQLPOINTER        pvParam);

Function arguments

The following table lists the data type, use, and description for each argument in this function.

Table 2. SQLGetStmtOption() arguments
Data type Argument Use Description
SQLHSTMT hstmt input Specifies a statement handle.
SQLUSMALLINT fOption input Specifies the attribute to set.
SQLPOINTER pvParam output Specifies the value of the attribute. Depending on the value of fOption this can be a 32-bit integer value, or a pointer to a nul-terminated character string. The maximum length of any character string returned is SQL_MAX_OPTION_STRING_LENGTH bytes (which excludes the nul-terminator).