SQLGetPoolID 函数

  • 项目

一致性
引入的版本：ODBC 3.81 标准符合性：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 获取诊断信息，并将SQL_SUCCESS_WITH_INFO返回到 SQLConnect 和 SQLDriverConnect 中的应用程序。

应用程序不应直接调用此函数。 支持驱动程序感知连接池的 ODBC 驱动程序必须实现此函数。

包括用于 ODBC 驱动程序开发的 sqlspi.h。

另请参阅

开发 ODBC 驱动程序
识别驱动程序的连接池
在 ODBC 驱动程序中开发连接池感知