title | description | author | ms.author | ms.date | ms.service | ms.subservice | ms.topic | helpviewer_keywords | |
---|---|---|---|---|---|---|---|---|---|
SQLGetPoolID Function |
SQLGetPoolID Function |
David-Engel |
davidengel |
01/19/2017 |
sql |
connectivity |
reference |
|
Conformance
Version Introduced: ODBC 3.81 Standards Compliance: ODBC
Summary
SQLGetPoolID retrieves the pool ID.
SQLRETURN SQLGetPoolID (
SQLHDBC_INFO_TOKEN hDbcInfoToken,
POOLID * pPoolID );
hDbcInfoToken
[Input] Token handle that contains all connection information.
pPoolID
[Output] The pool ID, which is used to identify a set of connections that can be used interchangeably (possibly requiring an additional reset).
SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_ERROR, or SQL_INVALID_HANDLE.
When SQLGetPoolID returns SQL_ERROR or SQL_SUCCESS_WITH_INFO, the Driver Manager will use a HandleType of SQL_HANDLE_DBC_INFO_TOKEN and a Handle of hDbcInfoToken.
SQLGetPoolID is used to obtain the pool ID given a set of connection information (from SQLSetConnectAttrForDbcInfo, SQLSetDriverConnectInfo, and SQLSetConnectInfo). This pool ID is used to identify a set of connections that can be used interchangeably (possibly requiring an additional reset). The pool ID will be used to identify the connection pool for that group of connections.
Whenever a driver returns SQL_ERROR or SQL_INVALID_HANDLE, the Driver Manager returns the error to the application (in SQLConnect or SQLDriverConnect).
Whenever a driver returns SQL_SUCCESS_WITH_INFO, the Driver Manager will obtain the diagnostic information from hDbcInfoToken, and return SQL_SUCCESS_WITH_INFO to the application in SQLConnect and SQLDriverConnect.
Applications should not call this function directly. An ODBC driver that supports driver-aware connection pooling must implement this function.
Include sqlspi.h for ODBC driver development.
Developing an ODBC Driver
Driver-Aware Connection Pooling
Developing Connection-Pool Awareness in an ODBC Driver