Função SQLPoolConnect

Conformidade
Versão Introduzida: Conformidade com as Normas ODBC 3.8: ODBC

Summary
O SQLPoolConnect é usado para criar uma nova ligação se nenhuma ligação no pool puder ser reutilizada.

Syntax

  
SQLRETURN  SQLPoolConnect(  
                SQLHDBC              hDbc,  
                SQLHDBC_INFO_TOKEN   hDbcInfoToken,  
                WCHAR *              wszOutConnectString,  
                SQLSMALLINT          cchConnectStringBuffer,  
                SQLSMALLINT *        cchConnectStringLen );  

Arguments

hDbc
[Entrada] A alavanca de ligação.

hDbcInfoToken
[Entrada] O handle do token para o novo pedido de ligação à aplicação.

wszOutConnectString
[Saída] Apontar para um buffer para a cadeia de ligação completa. Após a ligação bem-sucedida à fonte de dados alvo, este buffer contém a cadeia de ligação completa. As aplicações devem alocar pelo menos 1.024 caracteres para este buffer.

Se wszOutConnectString for NULL, cchConnectStringLen continuará a devolver o número total de caracteres (excluindo o carácter de terminação nula para dados de caracteres) disponíveis para devolver no buffer apontado por wszOutConnectString.

cchConnectStringBuffer
[Entrada] Comprimento do buffer *wszOutConnectString , em caracteres.

cchConnectStringLen
[Saída] Apontador para um buffer onde deves o número total de caracteres (excluindo o carácter de terminação nula) disponíveis para devolver em *wszOutConnectString. Se o número de caracteres disponíveis para devolver for maior ou igual a cchConnectStringBuffer, a cadeia de ligação completa em *wszOutConnectString é truncada para cchConnectStringBuffer menos o comprimento de um carácter de terminação nula.

Devoluções

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_ERROR, ou, SQL_INVALID_HANDLE.

Diagnósticos

Semelhante ao SQLDriverConnect para qualquer erro de validação de entrada, exceto que o Gestor de Drivers usará um HandleType de SQL_HANDLE_DBC_INFO_TOKEN e um Handle de hDbcInfoToken.

Observações

O Driver Manager garante que o handle HENV principal do hDbc e do hDbcInfoToken são os mesmos.

Ao contrário do SQLDriverConnect, não existe um argumento DriverCompletion que incentive os utilizadores a introduzirem informações de ligação. Um diálogo de prompting é proibido no cenário de pooling.

As aplicações não devem chamar esta função diretamente. Um driver ODBC que suporta pooling de conexões consciente do driver deve implementar esta função.

Sempre que um driver devolve SQL_ERROR ou SQL_INVALID_HANDLE, o Gestor de Drivers devolve o erro à aplicação (em SQLConnect ou SQLDriverConnect).

Sempre que um driver retorna SQL_SUCCESS_WITH_INFO, o Gestor de Drivers obtém a informação de diagnóstico do hDbcInfoToken e devolve SQL_SUCCESS_WITH_INFO à aplicação no SQLConnect e SQLDriverConnect.

Quando uma aplicação usa SQLConnect, wszOutConnectString será um buffer NULL (os últimos três parâmetros serão todos definidos para NULL, 0, NULL). Caso contrário, o driver deve devolver a cadeia de ligação de saída, que será devolvida à chamada SQLDriverConnect Function da aplicação.

Incluir sqlspi.h para desenvolvimento de drivers ODBC.