SQLGetPoolID 函数

一致性
推出版本:ODBC 3.81 标准合规:ODBC

总结
SQLGetPoolID 检索池 ID。

Syntax

  
SQLRETURN  SQLGetPoolID (  
                SQLHDBC_INFO_TOKEN    hDbcInfoToken,  
                POOLID *              pPoolID );  

Arguments

hDbcInfoToken
[输入]包含所有连接信息的令牌句柄。

pPoolID
[输出]池ID,用于标识一组可以互换使用的连接(可能需要额外重置)。

Returns

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 的 Handle。

Remarks

SQLGetPoolID 用于获得一组连接信息(来自 SQLSetConnectAttrForDbcInfo、 SQLSetDriverConnectInfo 和 SQLSetConnectInfo)的池 ID。 该池ID用于标识一组可互换使用的连接(可能需要额外重置)。 池ID用于识别该组连接的连接池。

每当驱动程序返回SQL_ERROR或 SQL_INVALID_HANDLE,驱动程序管理器会将错误返回给应用程序(通过 SQLConnect 或 SQLDriverConnect 进行)。

每当驱动程序返回SQL_SUCCESS_WITH_INFO时,驱动程序管理器会从 hDbcInfoToken 获取诊断信息,并通过 SQLConnect 和 SQLDriverConnect 返回SQL_SUCCESS_WITH_INFO给应用程序。

应用程序不应直接调用该函数。 支持驱动程序识别连接池的 ODBC 驱动程序必须实现此功能。

包含 sqlspi.h 以开发 ODBC 驱动。