SQLCleanupConnectionPoolID 関数
準拠
導入されたバージョン: ODBC 3.81 Standards Compliance: ODBC
まとめ
SQLCleanupConnectionPoolID は、プール ID がタイムアウトしたことをドライバーに通知します。プール ID は、そのプール ID に関連付けられているプール内のすべての接続がタイムアウトするたびにタイムアウトすることがあります。接続タイムアウトの詳細については、「 Microsoft データ アクセス コンポーネントのプール 」を参照してください。
構文
SQLRETURN SQLCleanupConnectionPoolID (
SQLHENV EnvironmentHandle
SQLPOOLID PoolID );
引数
EnvironmentHandle
[入力]プールの環境ハンドル。
PoolID
[入力]タイムアウトしたプール ID に関連付けられているプール。
戻り値
SQL_SUCCESS、SQL_SUCCESS_WITH_INFO、SQL_ERROR、またはSQL_INVALID_HANDLE。
診断
ドライバー マネージャーは、 SQLCleanupConnectionPoolID から返された診断情報を処理しません。
アプリケーションは、ドライバーによって返されたエラー メッセージを受け取ることができません。
解説
SQLCleanupConnectionPoolID はいつでも呼び出すことができますが、ドライバー マネージャーでは、他のスレッドが SQLGetPoolID を同時に呼び出す必要がなく、そのプール ID で割り当てられた接続情報トークンを使用して SQLRateConnection と SQLPoolConnect を同時に呼び出すスレッドがないことを保証します。 そのため、ドライバーは、この関数がスレッド セーフであることを確認する必要があります。
ドライバーは、プール ID に関連付けられているリソースをクリーンアップできます。
アプリケーションでは、この関数を直接呼び出さないでください。 ドライバー対応接続プールをサポートする ODBC ドライバーは、この関数を実装する必要があります。
ODBC ドライバー開発用に sqlspi.h を含めます。