SQLGetPoolID-Funktion

  • Artikel

Konformität
Eingeführte Version: ODBC 3.81-Standardkonformität: ODBC

Zusammenfassung
SQLGetPoolID ruft die Pool-ID ab.

Syntax

  
SQLRETURN  SQLGetPoolID (  
                SQLHDBC_INFO_TOKEN    hDbcInfoToken,  
                POOLID *              pPoolID );

Argumente

hDbcInfoToken
[Eingabe] Tokenhandle, das alle Verbindungsinformationen enthält.

pPoolID
[Ausgabe] Die Pool-ID, die verwendet wird, um eine Reihe von Verbindungen zu identifizieren, die austauschbar verwendet werden können (möglicherweise eine zusätzliche Zurücksetzung erforderlich).

Gibt zurück

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_ERROR oder SQL_INVALID_HANDLE.

Diagnose

Wenn SQLGetPoolID SQL_ERROR oder SQL_SUCCESS_WITH_INFO zurückgibt, verwendet der Treiber-Manager einen HandleType von SQL_HANDLE_DBC_INFO_TOKEN und ein Handle von hDbcInfoToken.

Bemerkungen

SQLGetPoolID wird zum Abrufen der Pool-ID verwendet, wenn eine Reihe von Verbindungsinformationen (von SQLSetConnectAttrForDbcInfo, SQLSetDriverConnectInfo und SQLSetConnectInfo) angegeben wird. Diese Pool-ID wird verwendet, um eine Reihe von Verbindungen zu identifizieren, die austauschbar verwendet werden können (möglicherweise eine zusätzliche Zurücksetzung erforderlich). Die Pool-ID wird verwendet, um den Verbindungspool für diese Gruppe von Verbindungen zu identifizieren.

Wenn ein Treiber SQL_ERROR oder SQL_INVALID_HANDLE zurückgibt, gibt der Treiber-Manager den Fehler an die Anwendung zurück (in SQLConnect oder SQLDriverConnect).

Wenn ein Treiber SQL_SUCCESS_WITH_INFO zurückgibt, ruft der Treiber-Manager die Diagnoseinformationen aus hDbcInfoToken ab und gibt SQL_SUCCESS_WITH_INFO an die Anwendung in SQLConnect und SQLDriverConnect zurück.

Anwendungen sollten diese Funktion nicht direkt aufrufen. Ein ODBC-Treiber, der treiberfähige Verbindungspooling unterstützt, muss diese Funktion implementieren.

Schließen Sie sqlspi.h für die ODBC-Treiberentwicklung ein.

Weitere Informationen

Entwickeln eines ODBC-Treibers
Treiberfähiges Verbindungspooling
Entwickeln von Verbindungspool-Unterstützung in einem ODBC-Treiber