SQLSetConnectInfo Function

Conformance

Version Introduced: ODBC 3.81 Standards Compliance: ODBC

Summary

SQLSetConnectInfo is used to set the data source, user ID, and password into the connection info token for an application’s SQLConnect call.

SQLRETURN  SQLSetConnectInfo(
                SQLHDBC_INFO_TOKEN   TokenHandle,
                WCHAR *              ServerName,
                SQLSMALLINT          NameLength1,
                WCHAR *              UserName,
                SQLSMALLINT          NameLength2,
                WCHAR *              Authentication,
                SQLSMALLINT          NameLength3 );

TokenHandle

[Input] Token handle.

ServerName

[Input] Data source name. The data might be located on the same computer as the program, or on another computer somewhere on a network. For information about how an application chooses a data source, see Choosing a Data Source or Driver.

NameLength1

[Input] Length of *ServerName in characters.

UserName

[Input] User identifier.

NameLength2

[Input] Length of *UserName in characters.

Authentication

[Input] Authentication string (typically the password).

NameLength3

[Input] Length of *Authentication in characters.

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_ERROR, or SQL_INVALID_HANDLE.

Same as SQLConnect for input validation errors, 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.

Show:
© 2014 Microsoft