contentsconceptssyntaxlibrariessampleserrorsindex
Full text search
function   SQLGetStmtAttr    
  Related Syntax     Other Library Functions  

Library: ODBC
Include: omodbc.xin
Returns: Numeric

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 counter function SQLGetStmtAttr
     (  read-only SQL_handle_type StatementHandle,
        value counter Attribute,
        read-only SQL_array_type Value,
        value counter BufferLength,
        modifiable counter StringLength )


Purpose

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:

    Related Syntax
   SQLGetConnectAttr
   SQLSetConnectAttr
   SQLSetStmtAttr
 
  Other Library Functions
   SQL_FUNC_EXISTS
   SQL_LibraryVersion
   SQLAllocConnect
   SQLAllocEnv
   SQLAllocHandle
   SQLAllocStmt
   SQLBindCol
   SQLBindParameter
   SQLBrowseConnect
   SQLBulkOperations
   SQLCancel
   SQLCloseCursor
   SQLColAttribute
   SQLColAttributes
   SQLColumnPrivileges
   SQLColumns
   SQLConnect
   SQLCopyDesc
   SQLDataSources
   SQLDescribeCol
   SQLDescribeParam
   SQLDisconnect
   SQLDriverConnect
   SQLDrivers
   SQLEndTran
   SQLError
   SQLExecDirect
   SQLExecute
   SQLExtendedFetch
   SQLFetch
   SQLFetchScroll
   SQLForeignKeys
   SQLFreeConnect
   SQLFreeEnv
   SQLFreeHandle
   SQLFreeStmt
   SQLGetArrayAsCounter
   SQLGetArrayAsCounterShelf
   SQLGetArrayAsStream
   SQLGetArrayAsStreamShelf
   SQLGetArrayAsString
   SQLGetArrayElementCount
   SQLGetArrayElementLen
   SQLGetConnectAttr
   SQLGetConnectOption
   SQLGetCursorName
   SQLGetData
   SQLGetDescField
   SQLGetDescRec
   SQLGetDiagField
   SQLGetDiagRec
   SQLGetEnvAttr
   SQLGetFunctions
   SQLGetInfo
   SQLGetStmtAttr
   SQLGetStmtOption
   SQLGetTypeInfo
   SQLGetVectorAsCounter
   SQLGetVectorAsStream
   SQLGetVectorAsString
   SQLGetVectorSize
   SQLMoreResults
   SQLNativeSQL
   SQLNumParams
   SQLNumResultCols
   SQLParamOptions
   SQLPrepare
   SQLPrimaryKeys
   SQLProcedureColumns
   SQLProcedures
   SQLPutData
   SQLRowCount
   SQLSetArrayAsCounter
   SQLSetArrayAsCounterShelf
   SQLSetArrayAsStream
   SQLSetArrayAsStreamShelf
   SQLSetArrayAsString
   SQLSetArraySize
   SQLSetConnectAttr
   SQLSetConnectOption
   SQLSetCursorName
   SQLSetDescField
   SQLSetDescRec
   SQLSetEnvAttr
   SQLSetPos
   SQLSetScrollOptions
   SQLSetStmtAttr
   SQLSetStmtOption
   SQLSetVectorAsCounter
   SQLSetVectorAsStream
   SQLSetVectorAsString
   SQLSetVectorSize
   SQLSpecialColumns
   SQLStatistics
   SQLTablePrivileges
   SQLTables
   SQLTransact
 
----  

Top [CONTENTS] [CONCEPTS] [SYNTAX] [LIBRARIES] [SAMPLES] [ERRORS] [INDEX]

Generated: April 21, 1999 at 2:01:18 pm
If you have any comments about this section of the documentation, send email to [email protected]

Copyright © OmniMark Technologies Corporation, 1988-1999.