FUNKCE SQLGetPoolID

Soulad
Představená verze: ODBC 3.81 Shoda standardů: ODBC

Summary
SQLGetPoolID získává ID poolu.

Syntax

  
SQLRETURN  SQLGetPoolID (  
                SQLHDBC_INFO_TOKEN    hDbcInfoToken,  
                POOLID *              pPoolID );  

Arguments

hDbcInfoToken
[Vstup] Token handle, který obsahuje veškeré informace o spojení.

pPoolID
[Výstup] ID poolu, které slouží k identifikaci sady spojení, jež lze používat zaměnitelně (což může vyžadovat další reset).

Returns

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_ERROR nebo SQL_INVALID_HANDLE.

Diagnostika

Když SQLGetPoolID vrátí SQL_ERROR nebo SQL_SUCCESS_WITH_INFO, správce ovladačů použije HandleType SQL_HANDLE_DBC_INFO_TOKEN a HandlehDbcInfoToken.

Remarks

SQLGetPoolID se používá k získání ID poolu na základě sady informací o připojení (ze SQLSetConnectAttrForDbcInfo, SQLSetDriverConnectinfo a SQLSetConnectInfo). Toto ID poolu se používá k identifikaci sady spojení, která lze používat zaměnitelně (což může vyžadovat další reset). ID poolu bude použito k identifikaci poolu spojení pro danou skupinu připojení.

Kdykoli ovladač vrátí SQL_ERROR nebo SQL_INVALID_HANDLE, správce ovladačů vrátí chybu aplikaci (v SQLConnect nebo SQLDriverConnect).

Kdykoli ovladač SQL_SUCCESS_WITH_INFO vrátí, správce ovladačů získá diagnostické informace z hDbcInfoToken a vrátí SQL_SUCCESS_WITH_INFO aplikaci v SQLConnect a SQLDriverConnect.

Aplikace by tuto funkci neměly volat přímo. ODBC ovladač, který podporuje poolování připojení s vědomím ovladačů, musí tuto funkci implementovat.

Zahrňte sqlspi.h pro vývoj ovladačů ODBC.