適合 性
導入されたバージョン:ODBC 3.81 規格準拠:ODBC
Summary
SQLGetPoolID はプールIDを取得します。
構文
SQLRETURN SQLGetPoolID (
SQLHDBC_INFO_TOKEN hDbcInfoToken,
POOLID * pPoolID );
引数
hDbcInfoToken
[入力]すべての接続情報を含むトークンハンドルです。
pPoolID
[出力]プールIDは、互換性のある接続セットを識別するために使われます(追加のリセットが必要な場合もあります)。
返品
SQL_SUCCESS、SQL_SUCCESS_WITH_INFO、SQL_ERROR、またはSQL_INVALID_HANDLE。
Diagnostics
SQLGetPoolIDがSQL_ERRORまたはSQL_SUCCESS_WITH_INFOを返すと、ドライバーマネージャーはSQL_HANDLE_DBC_INFO_TOKENのHandleTypeとhDbcInfoTokenのハンドルを使用します。
Remarks
SQLGetPoolID は、 SQLSetConnectAttrForDbcInfo、 SQLSetDriverConnectInfo、 SQLSetConnectInfoから得た一連の接続情報からプールIDを取得するために使われます。 このプールIDは、交換可能に使える接続群を識別するために使われます(追加のリセットが必要な場合もあります)。 プールIDは、その接続群の接続プールを特定するために使用されます。
ドライバーがSQL_ERRORまたはSQL_INVALID_HANDLEを返すたびに、ドライバーマネージャーはエラーをアプリケーション( SQLConnect または SQLDriverConnect)に返します。
ドライバーがSQL_SUCCESS_WITH_INFOを返すたびに、ドライバーマネージャーは hDbcInfoTokenから診断情報を取得し、 SQLConnect および SQLDriverConnectでSQL_SUCCESS_WITH_INFOをアプリケーションに返します。
アプリケーションはこの関数を直接呼び出すべきではありません。 ドライバー認識接続プーリングをサポートするODBCドライバーはこの機能を実装しなければなりません。
ODBCドライバー開発のためにsqlspi.hを含めてください。