Функция SQLGetPoolID

Соответствия
Представлена версия: соответствие стандартам ODBC 3.81: ODBC

Сводка
SQLGetPoolID получает идентификатор пула.

Синтаксис

  
SQLRETURN  SQLGetPoolID (  
                SQLHDBC_INFO_TOKEN    hDbcInfoToken,  
                POOLID *              pPoolID );  

Аргументы

hDbcInfoToken
[Входные данные] Дескриптор маркера, содержащий все сведения о подключении.

pPoolID
[Выходные данные] Идентификатор пула, который используется для идентификации набора подключений, которые можно использовать взаимозаменяемо (возможно, требуется дополнительный сброс).

Возвраты

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_ERROR или SQL_INVALID_HANDLE.

Диагностика

Когда SQLGetPoolID возвращает SQL_ERROR или SQL_SUCCESS_WITH_INFO, диспетчер драйверов будет использовать HandleType SQL_HANDLE_DBC_INFO_TOKEN и дескрипторhDbcInfoToken.

Замечания

SQLGetPoolID используется для получения идентификатора пула, заданного набором сведений о подключении (из SQLSetConnectAttrForDbcInfo, SQLSetDriverConnectInfo и SQLSetConnectInfo). Этот идентификатор пула используется для идентификации набора подключений, которые можно использовать взаимозаменяемо (возможно, требуется дополнительный сброс). Идентификатор пула будет использоваться для идентификации пула подключений для этой группы подключений.

Когда драйвер возвращает SQL_ERROR или SQL_INVALID_HANDLE, диспетчер драйверов возвращает ошибку приложению (в SQLConnect или SQLDriverConnect).

Когда драйвер возвращает SQL_SUCCESS_WITH_INFO, диспетчер драйверов получит диагностические сведения из hDbcInfoToken и возвращает SQL_SUCCESS_WITH_INFO приложению в SQLConnect и SQLDriverConnect.

Приложения не должны вызывать эту функцию напрямую. Драйвер ODBC, поддерживающий пул подключений с поддержкой драйверов, должен реализовать эту функцию.

Включите sqlspi.h для разработки драйверов ODBC.

См. также

Разработка драйвера ODBC
Организация пулов соединений с учетом драйвера
Разработка драйвера ODBC с поддержкой пула подключений