| title | SQLSetDriverConnectInfo Function | |
|---|---|---|
| description | SQLSetDriverConnectInfo Function | |
| author | David-Engel | |
| ms.author | davidengel | |
| ms.date | 01/19/2017 | |
| ms.service | sql | |
| ms.subservice | connectivity | |
| ms.topic | reference | |
| helpviewer_keywords |
|
|
| ms.custom | sfi-ropc-nochange |
Conformance
Version Introduced: ODBC 3.81 Standards Compliance: ODBC
Summary
SQLSetDriverConnectInfo is used to set the connection string into the connection info token for an application's SQLDriverConnect call.
SQLRETURN SQLSetDriverConnectInfo(
SQLHDBC_INFO_TOKEN hDbcInfoToken,
WCHAR * InConnectionString,
SQLSMALLINT StringLength1 ); TokenHandle
[Input] Token handle.
InConnectionString
[Input] A full connection string (see the syntax in "Comments" in SQLDriverConnect), a partial connection string, or an empty string.
StringLength1
[Input] Length of *InConnectionString, in characters if the string is Unicode, or bytes if string is ANSI or DBCS.
SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_ERROR, or SQL_INVALID_HANDLE.
Same as SQLDriverConnect related to any input validation error, except that the Driver Manager will use a HandleType of SQL_HANDLE_DBC_INFO_TOKEN and a Handle of hDbcInfoToken.
Whenever a driver returns SQL_ERROR or SQL_INVALID_HANDLE, the Driver Manager returns the error to the application (in SQLConnect or SQLDriverConnect).
Whenever a driver returns SQL_SUCCESS_WITH_INFO, the Driver Manager will obtain the diagnostic information from hDbcInfoToken, and return SQL_SUCCESS_WITH_INFO to the application in SQLConnect and SQLDriverConnect.
Applications should not call this function directly. An ODBC driver that supports driver-aware connection pooling must implement this function.
Include sqlspi.h for ODBC driver development.
Developing an ODBC Driver
Driver-Aware Connection Pooling
Developing Connection-Pool Awareness in an ODBC Driver