odbc-api-reference.md

title	ODBC API Reference
description	ODBC API Reference
author	David-Engel
ms.author	v-davidengel
ms.date	01/19/2017
ms.service	sql
ms.subservice	connectivity
ms.topic	reference
apitype	dllExport

ODBC API Reference

The topics in this section describe each ODBC function in alphabetical order. Each function is defined as a C programming language function. Descriptions include the following:

• Purpose

• ODBC version

• Standard CLI conformance level

• Syntax

• Arguments

• Return values

• Diagnostics

• Comments about usage and implementation

• Code example

• References to related functions

The standard CLI conformance level can be one of the following: ISO 92, Open Group, ODBC, or Deprecated. A function tagged as ISO 92-conformant also appears in Open Group version 1, because Open Group is a pure superset of ISO 92. A function tagged as Open Group-compliant also appears in ODBC 3.x, because ODBC 3.x is a pure superset of Open Group version 1. A function tagged as ODBC-compliant appears in neither standard. A function tagged as deprecated has been deprecated in ODBC 3.x.

Handling of diagnostic information is described in the SQLGetDiagField function description. The text associated with SQLSTATE values is included to provide a description of the condition but is not intended to prescribe specific text.

Note

For driver-specific information about ODBC functions, see the section for the driver.

This section contains topics for the following functions:

• SQLAllocConnect Function

• SQLAllocEnv Function

• SQLAllocHandle Function

• SQLAllocStmt Function

• SQLBindCol Function

• SQLBindParameter Function

• SQLBrowseConnect Function

• SQLBulkOperations Function

• SQLCancel Function

• SQLCancelHandle Function

• SQLCloseCursor Function

• SQLColAttribute Function

• SQLColAttributes Function

• SQLColumnPrivileges Function

• SQLColumns Function

• SQLCompleteAsync Function

• SQLConnect Function

• SQLCopyDesc Function

• SQLDataSources Function

• SQLDescribeCol Function

• SQLDescribeParam Function

• SQLDisconnect Function

• SQLDriverConnect Function

• SQLDrivers Function

• SQLEndTran Function

• SQLError Function

• SQLExecDirect Function

• SQLExecute Function

• SQLExtendedFetch Function

• SQLFetch Function

• SQLFetchScroll Function

• SQLForeignKeys Function

• SQLFreeConnect Function

• SQLFreeEnv Function

• SQLFreeHandle Function

• SQLFreeStmt Function

• SQLGetConnectAttr Function

• SQLGetConnectOption Function

• SQLGetCursorName Function

• SQLGetData Function

• SQLGetDescField Function

• SQLGetDescRec Function

• SQLGetDiagField Function

• SQLGetDiagRec Function

• SQLGetEnvAttr Function

• SQLGetFunctions Function

• SQLGetInfo Function

• SQLGetStmtAttr Function

• SQLGetStmtOption Function

• SQLGetTypeInfo Function

• SQLMoreResults Function

• SQLNativeSql Function

• SQLNumParams Function

• SQLNumResultCols Function

• SQLParamData Function

• SQLParamOptions Function

• SQLPrepare Function

• SQLPrimaryKeys Function

• SQLProcedureColumns Function

• SQLProcedures Function

• SQLPutData Function

• SQLRowCount Function

• SQLSetConnectAttr Function

• SQLSetConnectOption Function

• SQLSetCursorName Function

• SQLSetDescField Function

• SQLSetDescRec Function

• SQLSetEnvAttr Function

• SQLSetParam Function

• SQLSetPos Function

• SQLSetScrollOptions Function

• SQLSetStmtAttr Function

• SQLSetStmtOption Function

• SQLSpecialColumns Function

• SQLStatistics Function

• SQLTablePrivileges Function

• SQLTables Function

• SQLTransact Function