Skip to content

Commit 490d79d

Browse files
markingmynamemarkingmyname
committed
removed periods in the description column where available
1 parent e09207e commit 490d79d

4 files changed

Lines changed: 111 additions & 111 deletions

File tree

‎docs/relational-databases/native-client-odbc-api/odbc-api-implementation-details.md‎

Lines changed: 54 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,10 @@ ODBC uses four hierarchical handle types to manage state:
3434

3535
| Handle type | Purpose |
3636
| --- | --- |
37-
| **Environment (HENV)** | Global ODBC settings and versioning. |
38-
| **Connection (HDBC)** | Represents a connection to a specific data source. |
39-
| **Statement (HSTMT)** | Manages SQL statements, parameters, and result sets. |
40-
| **Descriptor (HDESC)** | Stores metadata for parameters and columns. |
37+
| **Environment (HENV)** | Global ODBC settings and versioning |
38+
| **Connection (HDBC)** | Represents a connection to a specific data source |
39+
| **Statement (HSTMT)** | Manages SQL statements, parameters, and result sets |
40+
| **Descriptor (HDESC)** | Stores metadata for parameters and columns |
4141

4242
### Driver manager and driver interaction
4343

@@ -89,126 +89,126 @@ Use these functions to establish, configure, and manage connections to SQL Serve
8989

9090
| Function | Description |
9191
| --- | --- |
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. |
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 |
9999

100100
### Execute SQL statements
101101

102102
Use these functions to prepare, execute, and manage SQL statements.
103103

104104
| Function | Description |
105105
| --- | --- |
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. |
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 |
111111

112112
### Bind parameters and columns
113113

114114
Use these functions to bind application variables to SQL parameters and result set columns.
115115

116116
| Function | Description |
117117
| --- | --- |
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. |
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 |
124124

125125
### Fetch and process results
126126

127127
Use these functions to retrieve data from result sets and process query results.
128128

129129
| Function | Description |
130130
| --- | --- |
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. |
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 |
138138

139139
### Discover schema and metadata
140140

141141
Use these functions to query database schema information such as tables, columns, and keys.
142142

143143
| Function | Description |
144144
| --- | --- |
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. |
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 |
153153

154154
### Column and result set metadata
155155

156156
Use these functions to examine the structure of result sets and column attributes.
157157

158158
| Function | Description |
159159
| --- | --- |
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. |
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 |
164164

165165
### Privileges and security
166166

167167
Use these functions to retrieve permission information for database objects.
168168

169169
| Function | Description |
170170
| --- | --- |
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. |
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 |
173173

174174
### Environment and statement attributes
175175

176176
Use these functions to configure ODBC environment and statement behavior.
177177

178178
| Function | Description |
179179
| --- | --- |
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. |
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 |
183183

184184
### Descriptors
185185

186186
Use these functions to directly manipulate descriptor records for advanced parameter and column handling.
187187

188188
| Function | Description |
189189
| --- | --- |
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. |
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 |
193193

194194
### Diagnostics and driver information
195195

196196
Use these functions to retrieve error information and query driver capabilities.
197197

198198
| Function | Description |
199199
| --- | --- |
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. |
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 |
203203

204204
### Resource cleanup
205205

206206
Use these functions to release handles and free resources.
207207

208208
| Function | Description |
209209
| --- | --- |
210-
| [SQLFreeHandle](sqlfreehandle.md) | Release an environment, connection, statement, or descriptor handle. |
211-
| [SQLFreeStmt](sqlfreestmt.md) | Free statement resources, close cursors, or unbind parameters and columns. |
210+
| [SQLFreeHandle](sqlfreehandle.md) | Release an environment, connection, statement, or descriptor handle |
211+
| [SQLFreeStmt](sqlfreestmt.md) | Free statement resources, close cursors, or unbind parameters and columns |
212212

213213
## Related content
214214

0 commit comments

Comments
 (0)