SQLGetPoolID 関数

  • [アーティクル]

準拠
導入されたバージョン: ODBC 3.81 Standards Compliance: ODBC

まとめ
SQLGetPoolID は プール ID を取得します。

構文

  
SQLRETURN  SQLGetPoolID (  
                SQLHDBC_INFO_TOKEN    hDbcInfoToken,  
                POOLID *              pPoolID );

引数

hDbcInfoToken
[入力]すべての接続情報を含むトークン ハンドル。

pPoolID
[出力]プール ID。これは、同じ意味で使用できる接続のセットを識別するために使用されます (追加のリセットが必要になる場合があります)。

戻り値

SQL_SUCCESS、SQL_SUCCESS_WITH_INFO、SQL_ERROR、またはSQL_INVALID_HANDLE。

診断

SQLGetPoolID がSQL_ERRORまたはSQL_SUCCESS_WITH_INFOを返す場合、ドライバー マネージャーは、SQL_HANDLE_DBC_INFO_TOKENの HandleType と hDbcInfoToken のハンドルを使用します。

解説

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 を含めます。

参照

ODBC ドライバーの開発
ドライバー対応接続プール
ODBC ドライバー対応接続プールの開発