SQLGetPoolID 函式

  • 發行項

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

摘要
SQLGetPoolID 會擷取集區識別碼。

語法

  
SQLRETURN  SQLGetPoolID (  
                SQLHDBC_INFO_TOKEN    hDbcInfoToken,  
                POOLID *              pPoolID );

引數

hDbcInfoToken
[輸入]包含所有連接資訊的權杖控制碼。

pPoolID
[輸出]集區識別碼，用來識別一組可交換使用的連線（可能需要額外的重設）。

傳回

SQL_SUCCESS、SQL_SUCCESS_WITH_INFO、SQL_ERROR或SQL_INVALID_HANDLE。

診斷

當 SQLGetPoolID 傳回SQL_ERROR或SQL_SUCCESS_WITH_INFO時 ，驅動程式管理員會使用 handleType of SQL_HANDLE_DBC_INFO_TOKEN 和 hDbcInfoToken 的 Handle 。

備註

SQLGetPoolID 可用來取得集區識別碼，提供一組連線資訊（從 SQLSetConnectAttrForDbcInfo、 SQLSetDriverConnectInfo 和 SQLSetConnectInfo ）。 此集區識別碼可用來識別一組可交換使用的連線（可能需要額外的重設）。 集區識別碼將用來識別該連線群組的連接集區。

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

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

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

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

另請參閱

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