SQLCleanupConnectionPoolID 関数

適合 性
導入されたバージョン:ODBC 3.81 規格準拠:ODBC

Summary
SQLCleanupConnectionPoolIDは、プールIDがタイムアウトしたことをドライバーに通知します。プールIDは、そのプールIDに関連付けられたすべての接続がタイムアウトされたときにタイムアウトされることがあります。接続のタイムアウトについては、「Microsoft Data Access Componentsのプーリング」をご覧ください。

構文

  
SQLRETURN  SQLCleanupConnectionPoolID (  
                SQLHENV    EnvironmentHandle  
                SQLPOOLID  PoolID );  

引数

EnvironmentHandle
[入力]プールの環境ハンドル。

PoolID
[入力]タイムアウトされたプールIDに関連付けられたプールです。

返品

SQL_SUCCESS、SQL_SUCCESS_WITH_INFO、SQL_ERROR、またはSQL_INVALID_HANDLE。

Diagnostics

ドライバーマネージャーは SQLCleanupConnectionPoolIDから返された診断情報を処理しません。

アプリケーションはドライバーから返されたエラーメッセージを受け取ることができません。

Remarks

SQLCleanupConnectionPoolID はいつでも呼び出せますが、ドライバーマネージャーは他のスレッドが同時に SQLGetPoolID を呼び出さず、また他のスレッドがそのプールIDに割り当てられた接続情報トークンで SQLRateConnectionSQLPoolConnect を同時に呼び出していないことを保証します。 したがって、ドライバーはこの機能がスレッド安全であることを必ず確認しなければなりません。

ドライバーはプールIDに関連するリソースをクリーンアップできます。

アプリケーションはこの関数を直接呼び出すべきではありません。 ドライバー認識接続プーリングをサポートするODBCドライバーはこの機能を実装しなければなりません。

ODBCドライバー開発のためにsqlspi.hを含めてください。