Related Syntax		Other Library Functions

function

SQLGetStmtAttr

Library: omodbc - low-level ODBC support Include: omodbc.xin

Return type: Integer Returns:        An SQL return code. The following values may be returned: SQL_SUCCESS (the current setting was retrieved). SQL_SUCCESS_WITH_INFO (the current setting was retrieved, but a message was issued). SQL_ERROR (an error occurred). SQL_INVALID_HANDLE (the handle is invalid).

Declaration

  define external integer function SQLGetStmtAttr
     (  read-only SQL_handle_type StatementHandle,
        value integer Attribute,
        read-only SQL_array_type Value,
        value integer BufferLength,
        modifiable integer StringLength )

Returns the current setting of a statement attribute.

Input arguments:

1. StatementHandle.
2. Attribute. The attribute identifier. The following values are allowed:
   • SQL_ATTR_APP_ROW_DESC
   • SQL_ATTR_APP_PARAM_DESC
   • SQL_ATTR_IMP_ROW_DESC
   • SQL_ATTR_IMP_PARAM_DESC
   • SQL_ATTR_CURSOR_SCROLLABLE
   • SQL_ATTR_CURSOR_SENSITIVITY
   • SQL_ATTR_ASYNC_ENABLE
   • SQL_ATTR_CONCURRENCY
   • SQL_ATTR_CURSOR_TYPE
   • SQL_ATTR_ENABLE_AUTO_IPD
   • SQL_ATTR_FETCH_BOOKMARK_PTR
   • SQL_ATTR_KEYSET_SIZE
   • SQL_ATTR_MAX_LENGTH
   • SQL_ATTR_MAX_ROWS
   • SQL_ATTR_NOSCAN
   • SQL_ATTR_PARAM_BIND_OFFSET_PTR
   • SQL_ATTR_PARAM_BIND_TYPE
   • SQL_ATTR_PARAM_OPERATION_PTR
   • SQL_ATTR_PARAM_STATUS_PTR
   • SQL_ATTR_PARAMS_PROCESSED_PTR
   • SQL_ATTR_PARAMSET_SIZE
   • SQL_ATTR_QUERY_TIMEOUT
   • SQL_ATTR_RETRIEVE_DATA
   • SQL_ATTR_ROW_BIND_OFFSET_PTR
   • SQL_ATTR_ROW_BIND_TYPE
   • SQL_ATTR_ROW_OPERATION_PTR
   • SQL_ATTR_ROW_STATUS_PTR
   • SQL_ATTR_ROWS_FETCHED_PTR
   • SQL_ATTR_ROW_ARRAY_SIZE
   • SQL_ATTR_SIMULATE_CURSOR
3. Value. A pointer to a buffer in which to return the value.
4. BufferLength. The maximum length of Value.

Output argument:

• StringLength. The returned length of Value.