SQLGetPoolID-Funktion

Konformität
Eingeführte Version: ODBC 3.81 Normeneinhaltung: ODBC

Summary
SQLGetPoolID ruft die Pool-ID ab.

Syntax

  
SQLRETURN  SQLGetPoolID (  
                SQLHDBC_INFO_TOKEN    hDbcInfoToken,  
                POOLID *              pPoolID );

Argumente

hDbcInfoToken
[Eingabe] Token-Handle, der alle Verbindungsinformationen enthält.

pPoolID
[Ausgabe] Die Pool-ID, die verwendet wird, um eine Menge von Verbindungen zu identifizieren, die austauschbar verwendet werden können (möglicherweise einen zusätzlichen Reset erfordern).

Rücklieferungen

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_ERROR oder SQL_INVALID_HANDLE.

Diagnostics

Wenn SQLGetPoolID SQL_ERROR oder SQL_SUCCESS_WITH_INFO zurückgibt, verwendet der Treibermanager einen HandleType von SQL_HANDLE_DBC_INFO_TOKEN und einen Handle von hDbcInfoToken.

Bemerkungen

SQLGetPoolID wird verwendet, um die Pool-ID zu erhalten, die eine Menge von Verbindungsinformationen erhält (von SQLSetConnectAttrForDbcInfo, SQLSetDriverConnectInfo und SQLSetConnectInfo). Diese Pool-ID wird verwendet, um eine Menge von Verbindungen zu identifizieren, die austauschbar verwendet werden können (was möglicherweise einen zusätzlichen Reset erfordert). Die Pool-ID wird verwendet, um den Verbindungspool für diese Verbindungsgruppe zu identifizieren.

Wann immer ein Treiber SQL_ERROR oder SQL_INVALID_HANDLE zurückgibt, gibt der Treibermanager den Fehler an die Anwendung zurück (in SQLConnect oder SQLDriverConnect).

Wann immer ein Treiber SQL_SUCCESS_WITH_INFO zurückgibt, erhält der Treibermanager die Diagnoseinformationen von hDbcInfoToken und gibt SQL_SUCCESS_WITH_INFO in SQLConnect und SQLDriverConnect an die Anwendung zurück.

Anwendungen sollten diese Funktion nicht direkt aufrufen. Ein ODBC-Treiber, der treiberbewusstes Connection Pooling unterstützt, muss diese Funktion implementieren.

Fügen Sie sqlspi.h für die Entwicklung von ODBC-Treibern hinzu.

Verwandte Inhalte

  • Last updated on