SQLSetDriverConnectInfo 函式

一致性
引進的版本:ODBC 3.81 標準合規性:ODBC

摘要
SQLSetDriverConnectInfo 可用來將連接字串設定為應用程式 SQLDriverConnect 呼叫的 連線資訊權杖。

語法

  
SQLRETURN SQLSetDriverConnectInfo(  
                SQLHDBC_INFO_TOKEN   hDbcInfoToken,  
                WCHAR *              InConnectionString,  
                SQLSMALLINT          StringLength1 );  

引數

TokenHandle
[輸入]權杖控制碼。

InConnectionString
[輸入]完整的連接字串(請參閱 SQLDriverConnect 中的「批註」語法 、部分連接字串或空字串。

StringLength1
[輸入]* InConnectionString 的長度,如果字串為 Unicode,則為字元,如果字串為 ANSI 或 DBCS,則為位元組。

傳回

SQL_SUCCESS、SQL_SUCCESS_WITH_INFO、SQL_ERROR或SQL_INVALID_HANDLE。

診斷

任何輸入驗證錯誤相關的 SQLDriverConnect 相同,不同之處在于 Driver Manager 會使用 SQL_HANDLE_DBC_INFO_TOKEN 的 HandleType hDbcInfoToken HandleType

備註

每當驅動程式傳回SQL_ERROR或SQL_INVALID_HANDLE時,驅動程式管理員就會將錯誤傳回應用程式(在 SQLConnect 或 SQLDriverConnect 中)。

每當驅動程式傳回SQL_SUCCESS_WITH_INFO時,驅動程式管理員就會從 hDbcInfoToken 取得診斷資訊,並將SQL_SUCCESS_WITH_INFO傳回 SQLConnect 和 SQLDriverConnect 中的 應用程式。

應用程式不應該直接呼叫此函式。 支援驅動程式感知連接共用的 ODBC 驅動程式必須實作此函式。

包含 sqlspi.h 以進行 ODBC 驅動程式開發。

另請參閱

開發 ODBC 驅動程式
可感知驅動程式的連接共用
在 ODBC 驅動程式中開發連線集區覺察