You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -79,62 +79,136 @@ Use Unicode APIs for modern applications.
79
79
- Thread safety depends on how the application configures the driver and Driver Manager.
80
80
- To reduce connection overhead, enable connection pooling at either level.
81
81
82
-
## ODBC API reference (table layout)
82
+
## ODBC API reference
83
83
84
-
The following table lists the available ODBC API functions documented for the SQL Server Native Client driver. Each entry links to its corresponding detailed reference page.
84
+
The following sections group the ODBC API functions by task. Each entry links to the detailed reference page for the SQL Server Native Client driver.
85
+
86
+
### Connection and data source
87
+
88
+
Use these functions to establish, configure, and manage connections to SQL Server.
89
+
90
+
| Function | Description |
91
+
| --- | --- |
92
+
|[SQLConnect](sqlconnect.md)| Establish a connection to a data source using a DSN, user ID, and password. |
93
+
|[SQLDriverConnect](sqldriverconnect.md)| Connect using a connection string with driver-specific keywords. |
94
+
|[SQLBrowseConnect](sqlbrowseconnect.md)| Discover connection attributes interactively to build a connection string. |
95
+
|[SQLConfigDataSource](sqlconfigdatasource.md)| Create, modify, or delete data source names (DSNs) programmatically. |
96
+
|[SQLDrivers](sqldrivers.md)| List all installed ODBC drivers and their attributes. |
97
+
|[SQLGetConnectAttr](sqlgetconnectattr.md)| Retrieve the current value of a connection attribute. |
98
+
|[SQLSetConnectAttr](sqlsetconnectattr.md)| Configure connection behavior such as timeouts and transaction isolation. |
99
+
100
+
### Execute SQL statements
101
+
102
+
Use these functions to prepare, execute, and manage SQL statements.
103
+
104
+
| Function | Description |
105
+
| --- | --- |
106
+
|[SQLExecDirect](sqlexecdirect.md)| Execute a SQL statement immediately without preparation. |
107
+
|[SQLExecute](sqlexecute.md)| Execute a previously prepared SQL statement. |
108
+
|[SQLCancel](sqlcancel.md)| Cancel an in-progress statement execution. |
109
+
|[SQLNativeSql](sqlnativesql.md)| Translate ODBC SQL syntax to the driver's native SQL dialect. |
110
+
|[SQLEndTran](sqlendtran.md)| Commit or roll back a transaction on a connection or environment. |
111
+
112
+
### Bind parameters and columns
113
+
114
+
Use these functions to bind application variables to SQL parameters and result set columns.
115
+
116
+
| Function | Description |
117
+
| --- | --- |
118
+
|[SQLBindParameter](sqlbindparameter.md)| Bind an application buffer to a SQL statement parameter marker. |
119
+
|[SQLBindCol](sqlbindcol.md)| Bind an application buffer to a result set column. |
120
+
|[SQLParamData](sqlparamdata.md)| Get the next parameter that needs data during data-at-execution operations. |
121
+
|[SQLPutData](sqlputdata.md)| Send parameter data in chunks during statement execution. |
122
+
|[SQLDescribeParam](sqldescribeparam.md)| Retrieve the data type and size of a parameter marker. |
123
+
|[SQLNumParams](sqlnumparams.md)| Count the number of parameters in a prepared statement. |
124
+
125
+
### Fetch and process results
126
+
127
+
Use these functions to retrieve data from result sets and process query results.
128
+
129
+
| Function | Description |
130
+
| --- | --- |
131
+
|[SQLFetch](sqlfetch.md)| Fetch the next rowset of data and return bound column values. |
132
+
|[SQLFetchScroll](sqlfetchscroll.md)| Fetch a rowset at an absolute or relative position in the result set. |
133
+
|[SQLGetData](sqlgetdata.md)| Retrieve data for a single unbound column or large data in chunks. |
134
+
|[SQLMoreResults](sqlmoreresults.md)| Move to the next result set when a statement returns multiple results. |
135
+
|[SQLRowCount](sqlrowcount.md)| Get the number of rows affected by INSERT, UPDATE, or DELETE statements. |
136
+
|[SQLCloseCursor](sqlclosecursor.md)| Close the cursor and discard pending results. |
137
+
|[SQLGetCursorName](sqlgetcursorname.md)| Retrieve the name associated with a statement's cursor. |
138
+
139
+
### Discover schema and metadata
140
+
141
+
Use these functions to query database schema information such as tables, columns, and keys.
142
+
143
+
| Function | Description |
144
+
| --- | --- |
145
+
|[SQLTables](sqltables.md)| List tables, views, and other table-like objects in the data source. |
146
+
|[SQLColumns](sqlcolumns.md)| List columns and their attributes for specified tables. |
147
+
|[SQLPrimaryKeys](sqlprimarykeys.md)| Retrieve the primary key columns for a table. |
148
+
|[SQLForeignKeys](sqlforeignkeys.md)| List foreign keys for a table or foreign keys in other tables that reference it. |
149
+
|[SQLSpecialColumns](sqlspecialcolumns.md)| Identify columns that uniquely identify a row or update automatically. |
150
+
|[SQLStatistics](sqlstatistics.md)| Retrieve index information and table statistics. |
151
+
|[SQLProcedures](sqlprocedures.md)| List stored procedures available in the data source. |
152
+
|[SQLProcedureColumns](sqlprocedurecolumns.md)| Describe input/output parameters and result columns for stored procedures. |
153
+
154
+
### Column and result set metadata
155
+
156
+
Use these functions to examine the structure of result sets and column attributes.
157
+
158
+
| Function | Description |
159
+
| --- | --- |
160
+
|[SQLDescribeCol](sqldescribecol.md)| Get the column name, type, size, and nullability for a result column. |
161
+
|[SQLColAttribute](sqlcolattribute.md)| Retrieve a specific attribute of a result set column. |
162
+
|[SQLNumResultCols](sqlnumresultcols.md)| Count the number of columns in a result set. |
163
+
|[SQLGetTypeInfo](sqlgettypeinfo.md)| List the SQL data types supported by the data source. |
164
+
165
+
### Privileges and security
166
+
167
+
Use these functions to retrieve permission information for database objects.
168
+
169
+
| Function | Description |
170
+
| --- | --- |
171
+
|[SQLTablePrivileges](sqltableprivileges.md)| List privileges granted on tables in the data source. |
172
+
|[SQLColumnPrivileges](sqlcolumnprivileges.md)| List privileges granted on specific columns of a table. |
173
+
174
+
### Environment and statement attributes
175
+
176
+
Use these functions to configure ODBC environment and statement behavior.
177
+
178
+
| Function | Description |
179
+
| --- | --- |
180
+
|[SQLSetEnvAttr](sqlsetenvattr.md)| Set environment attributes such as ODBC version and connection pooling. |
181
+
|[SQLGetStmtAttr](sqlgetstmtattr.md)| Retrieve the current value of a statement attribute. |
182
+
|[SQLSetStmtAttr](sqlsetstmtattr.md)| Configure statement behavior such as cursor type and query timeout. |
183
+
184
+
### Descriptors
185
+
186
+
Use these functions to directly manipulate descriptor records for advanced parameter and column handling.
187
+
188
+
| Function | Description |
189
+
| --- | --- |
190
+
|[SQLGetDescField](sqlgetdescfield.md)| Retrieve a single field from a descriptor record. |
191
+
|[SQLSetDescField](sqlsetdescfield.md)| Set a single field in a descriptor record. |
192
+
|[SQLSetDescRec](sqlsetdescrec.md)| Set multiple fields in a descriptor record with a single call. |
193
+
194
+
### Diagnostics and driver information
195
+
196
+
Use these functions to retrieve error information and query driver capabilities.
197
+
198
+
| Function | Description |
199
+
| --- | --- |
200
+
|[SQLGetDiagField](sqlgetdiagfield.md)| Retrieve a diagnostic field from an environment, connection, or statement. |
201
+
|[SQLGetInfo](sqlgetinfo.md)| Get general information about the driver and data source capabilities. |
202
+
|[SQLGetFunctions](sqlgetfunctions.md)| Determine which ODBC functions the driver supports. |
203
+
204
+
### Resource cleanup
205
+
206
+
Use these functions to release handles and free resources.
85
207
86
208
| Function | Description |
87
209
| --- | --- |
88
-
|[SQLBindCol](../../relational-databases/native-client-odbc-api/sqlbindcol.md)| Bind application variables to result columns. |
89
-
|[SQLBindParameter](../../relational-databases/native-client-odbc-api/sqlbindparameter.md)| Bind application variables to SQL statement parameters. |
0 commit comments