SQLCleanupConnectionPoolID, fonction

Conformité
Version introduite : Conformité aux normes ODBC 3.81 : ODBC

Résumé
SQLCleanupConnectionPoolID informe un pilote qu’un ID de pool a expiré. Un ID de pool peut expirer chaque fois que toutes les connexions d’un pool associé à cet ID de pool ont été expirées. Pour plus d’informations sur le délai d’expiration de connexion, consultez Regroupement dans les composants Microsoft Data Access .

Syntaxe

  
SQLRETURN  SQLCleanupConnectionPoolID (  
                SQLHENV    EnvironmentHandle  
                SQLPOOLID  PoolID );  

Arguments

EnvironmentHandle
[Entrée] Handle d’environnement du pool.

PoolID
[Entrée] Pool associé à l’ID de pool qui a expiré.

Retours

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_ERROR ou SQL_INVALID_HANDLE.

Diagnostics

Le Gestionnaire de pilotes ne traite pas les informations de diagnostic retournées par SQLCleanupConnectionPoolID.

Une application ne peut pas recevoir le message d’erreur retourné par le pilote.

Remarques

SQLCleanupConnectionPoolID peut être appelé à tout moment, mais le Gestionnaire de pilotes garantit qu’aucun autre thread n’appelle simultanément SQLGetPoolID et qu’aucun autre thread n’appelle simultanément SQLRateConnection et SQLPoolConnect avec un jeton d’informations de connexion affecté à cet ID de pool. Par conséquent, le pilote doit s’assurer que cette fonction est thread-safe.

Un pilote peut nettoyer les ressources associées à l’ID de pool.

Les applications ne doivent pas appeler cette fonction directement. Un pilote ODBC qui prend en charge le regroupement de connexions prenant en charge les pilotes doit implémenter cette fonction.

Incluez sqlspi.h pour le développement de pilotes ODBC.

Voir aussi

Développement d’un pilote ODBC
Regroupement de connexions prenant en charge les pilotes
Développement de la reconnaissance des pools de connexions dans un pilote ODBC