|
ODBC Driver for SQL ServerSupported ODBC API Functions |
|
|
|
ODBC Driver for SQL ServerSupported ODBC API Functions |
|
This section summarizes ODBC routines, categorized by functionality.
For the complete ODBC API reference, please refer to the ODBC Programmer's Reference at http://msdn.microsoft.com/en-us/library/ms714177.aspx.
An application can call SQLGetInfo function to obtain conformance information about ODBC Driver for SQL Server. To obtain information about support for a specific function in the driver, an application can call SQLGetFunctions.
|
Important Note: For backward compatibility, ODBC Driver for SQL Server supports all deprecated functions. |
The following tables list ODBC Driver for SQL Server calls grouped by task:
| Function Name | Support | Standard | Purpose |
|---|---|---|---|
|
SQLAllocHandle |
|
ISO 92 |
Obtains an environment, connection, statement, or descriptor handle. |
|
SQLConnect |
|
ISO 92 |
Connects to a specific driver by data source name, user ID, and password. |
|
SQLDriverConnect |
|
ODBC |
Connects to a specific driver by connection string or requests that the Driver Manager and driver display connection dialog boxes for the user. |
|
SQLAllocEnv |
|
Deprecated |
Obtains an environment handle allocated from driver. |
|
SQLAllocConnect |
|
Deprecated |
Obtains a connection handle |
| Function Name | Support | Standard | Purpose |
|---|---|---|---|
|
SQLDataSources |
|
ISO 92 |
Returns the list of available data sources, handled by the Driver Manager |
|
SQLDrivers |
|
ODBC |
Returns the list of installed drivers and their attributes, handles by Driver Manager |
|
SQLGetInfo |
|
ISO 92 |
Returns information about a specific driver and data source. |
|
SQLGetFunctions |
|
ISO 92 |
Returns supported driver functions. |
|
SQLGetTypeInfo |
|
ISO 92 |
Returns information about supported data types. |
| Function Name | Support | Standard | Purpose |
|---|---|---|---|
|
SQLSetConnectAttr |
|
ISO 92 |
Sets a connection attribute. |
|
SQLGetConnectAttr |
|
ISO 92 |
Returns the value of a connection attribute. |
|
SQLSetConnectOption |
|
Deprecated |
Sets a connection option |
|
SQLGetConnectOption |
|
Deprecated |
Returns the value of a connection option |
|
SQLSetEnvAttr |
|
ISO 92 |
Sets an environment attribute. |
|
SQLGetEnvAttr |
|
ISO 92 |
Returns the value of an environment attribute. |
|
SQLSetStmtAttr |
|
ISO 92 |
Sets a statement attribute. |
|
SQLGetStmtAttr |
|
ISO 92 |
Returns the value of a statement attribute. |
|
SQLSetStmtOption |
|
Deprecated |
Sets a statement option |
|
SQLGetStmtOption |
|
Deprecated |
Returns the value of a statement option |
| Function Name | Support | Standard | Purpose |
|---|---|---|---|
|
SQLAllocStmt |
|
Deprecated |
Allocates a statement handle |
|
SQLPrepare |
|
ISO 92 |
Prepares an SQL statement for later execution. |
|
SQLBindParameter |
|
ODBC |
Assigns storage for a parameter in an SQL statement. |
|
SQLGetCursorName |
|
ISO 92 |
Returns the cursor name associated with a statement handle. |
|
SQLSetCursorName |
|
ISO 92 |
Specifies a cursor name. |
|
SQLSetScrollOptions |
|
ODBC |
Sets options that control cursor behavior. |
| Function Name | Support | Standard | Purpose |
|---|---|---|---|
|
SQLExecute |
|
ISO 92 |
Executes a prepared statement. |
|
SQLExecDirect |
|
ISO 92 |
Executes a statement |
|
SQLNativeSql |
|
ODBC |
Returns the text of an SQL statement as translated by the driver. |
|
SQLDescribeParam |
|
ODBC |
Returns the description for a specific parameter in a statement. |
|
SQLNumParams |
|
ISO 92 |
Returns the number of parameters in a statement. |
|
SQLParamData |
|
ISO 92 |
Used in conjunction with SQLPutData to supply parameter data at execution time. (Useful for long data values.) |
|
SQLPutData |
|
ISO 92 |
Sends part or all of a data value for a parameter. (Useful for long data values.) |
| Function Name | Support | Standard | Purpose |
|---|---|---|---|
|
SQLRowCount |
|
ISO 92 |
Returns the number of rows affected by an insert, update, or delete request. |
|
SQLNumResultCols |
|
ISO 92 |
Returns the number of columns in the result set. |
|
SQLDescribeCol |
|
ISO 92 |
Describes a column in the result set. |
|
SQLColAttribute |
|
ISO 92 |
Describes attributes of a column in the result set. |
|
SQLColAttributes |
|
Deprecated |
Describes attributes of a column in the result set. |
|
SQLFetch |
|
ISO 92 |
Returns multiple result rows. |
|
SQLFetchScroll |
|
ISO 92 |
Returns scrollable result rows. |
|
SQLExtendedFetch |
|
Deprecated |
Returns scrollable result rows. |
|
SQLSetPos |
|
ODBC |
Positions a cursor within a fetched block of data and enables an application to refresh data in the rowset or to update or delete data in the result set. |
|
SQLBulkOperations |
|
ODBC |
Performs bulk insertions and bulk bookmark operations, including update, delete, and fetch by bookmark. |
| Function Name | Support | Standard | Purpose |
|---|---|---|---|
|
SQLError |
|
Deprecated |
Returns additional error or status information |
|
SQLGetDiagField |
|
ISO 92 |
Returns additional diagnostic information (a single field of the diagnostic data structure). |
|
SQLGetDiagRec |
|
ISO 92 |
Returns additional diagnostic information (multiple fields of the diagnostic data structure). |
| Function Name | Support | Standard | Purpose |
|---|---|---|---|
|
SQLColumnPrivileges |
|
ODBC |
Returns a list of columns and associated privileges for one or more tables. |
|
SQLColumns |
|
X/Open |
Returns the list of column names in specified tables. |
|
SQLForeignKeys |
|
ODBC |
Returns a list of column names that make up foreign keys, if they exist for a specified table. |
|
SQLPrimaryKeys |
|
ODBC |
Returns the list of column names that make up the primary key for a table. |
|
SQLSpecialColumns |
|
X/Open |
Returns information about the optimal set of columns that uniquely identifies a row in a specified table, or the columns that are automatically updated when any value in the row is updated by a transaction. |
|
SQLStatistics |
|
ISO 92 |
Returns statistics about a single table and the list of indexes associated with the table. |
|
SQLTablePrivileges |
|
ODBC |
Returns a list of tables and the privileges associated with each table. |
|
SQLTables |
|
X/Open |
Returns the list of table names stored in a specific data source. |
| Function Name | Support | Standard | Purpose |
|---|---|---|---|
|
SQLTransact |
|
Deprecated |
Commits or rolls back a transaction |
|
SQLEndTran |
|
ISO 92 |
Commits or rolls back a transaction. |
| Function Name | Support | Standard | Purpose |
|---|---|---|---|
|
SQLFreeStmt |
|
ISO 92 |
Ends statement processing, discards pending results, and, optionally, frees all resources associated with the statement handle. |
|
SQLCloseCursor |
|
ISO 92 |
Closes a cursor that has been opened on a statement handle. |
|
SQLCancel |
|
ISO 92 |
Cancels an SQL statement. |
| Function Name | Support | Standard | Purpose |
|---|---|---|---|
|
SQLDisconnect |
|
ISO 92 |
Closes the connection. |
|
SQLFreeHandle |
|
ISO 92 |
Releases an environment, connection, statement, or descriptor handle. |
|
SQLFreeConnect |
|
Deprecated |
Releases connection handle. |
|
SQLFreeEnv |
|
Deprecated |
Releases an environment handle. |
