SQLGetPoolID 函式

符合性
推出版本:ODBC 3.81 標準合規:ODBC

總結
SQLGetPoolID 會取得該池 ID。

Syntax

  
SQLRETURN  SQLGetPoolID (  
                SQLHDBC_INFO_TOKEN    hDbcInfoToken,  
                POOLID *              pPoolID );  

論點

hDbcInfoToken
[輸入]包含所有連線資訊的令牌代柄。

pPoolID
[輸出]池 ID 用來識別一組可互換使用的連線(可能需要額外重置)。

Returns

SQL_SUCCESS、SQL_SUCCESS_WITH_INFO、SQL_ERROR或SQL_INVALID_HANDLE。

Diagnostics

SQLGetPoolID 回傳 SQL_ERROR 或 SQL_SUCCESS_WITH_INFO 時,驅動程式管理器會使用 SQL_HANDLE_DBC_INFO_TOKEN 的 HandleTypehDbcInfoTokenHandle

備註

SQLGetPoolID 用於取得一組連線資訊(來自 SQLSetConnectAttrForDbcInfoSQLSetDriverConnectInfoSQLSetConnectInfo)的池 ID。 此池 ID 用來識別一組可互換使用的連線(可能需要額外重置)。 池 ID 將用來識別該組連線的連線池。

每當驅動返回 SQL_ERROR 或 SQL_INVALID_HANDLE,驅動管理員會將錯誤傳回應用程式(以 SQLConnectSQLDriverConnect 進行)。

每當驅動程式返回SQL_SUCCESS_WITH_INFO時,驅動程式管理器會從 hDbcInfoToken 取得診斷資訊,並以 SQLConnectSQLDriverConnect 將SQL_SUCCESS_WITH_INFO回傳給應用程式。

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

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