SQLGetPoolID-funktion

Överensstämmelse
Version introducerad: ODBC 3.81 Standardefterlevnad: ODBC

Summary
SQLGetPoolID hämtar pool-ID:t.

Syntax

  
SQLRETURN  SQLGetPoolID (  
                SQLHDBC_INFO_TOKEN    hDbcInfoToken,  
                POOLID *              pPoolID );  

Arguments

hDbcInfoToken
[Input] Tokenhandtag som innehåller all anslutningsinformation.

pPoolID
[Utdata] Pool-ID:t, som används för att identifiera en uppsättning anslutningar som kan användas omväxlande (eventuellt med behov av en extra återställning).

Returns

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_ERROR eller SQL_INVALID_HANDLE.

Diagnostics

När SQLGetPoolID returnerar SQL_ERROR eller SQL_SUCCESS_WITH_INFO använder Driver Manager en HandleType av SQL_HANDLE_DBC_INFO_TOKEN och ett Handle av hDbcInfoToken.

Remarks

SQLGetPoolID används för att erhålla pool-ID baserat på en uppsättning anslutningsinformation (från SQLSetConnectAttrForDbcInfo, SQLSetDriverConnectInfo och SQLSetConnectInfo). Detta pool-ID används för att identifiera en uppsättning anslutningar som kan användas omväxlande (vilket eventuellt kräver en extra återställning). Pool-ID:t kommer att användas för att identifiera anslutningspoolen för den gruppen av anslutningar.

När en drivrutin returnerar SQL_ERROR eller SQL_INVALID_HANDLE returnerar Driver Manager felet till applikationen (i SQLConnect eller SQLDriverConnect).

När en drivrutin returnerar SQL_SUCCESS_WITH_INFO hämtar Driver Manager diagnosinformationen från hDbcInfoToken och returnerar SQL_SUCCESS_WITH_INFO till applikationen i SQLConnect och SQLDriverConnect.

Applikationer bör inte anropa denna funktion direkt. En ODBC-drivrutin som stödjer drivrutinsmedveten anslutningspooling måste implementera denna funktion.

Inkludera sqlspi.h för ODBC-drivrutinsutveckling.