SQLCleanupConnectionPoolID 函数
一致性
引入的版本:ODBC 3.81 标准符合性: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。