Função SQLPoolConnect

Conformidade
Versão Introduzida: Conformidade com os Padrões ODBC 3.8: ODBC

Summary
O SQLPoolConnect é usado para criar uma nova conexão caso nenhuma conexão no pool possa ser reutilizada.

Sintaxe

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

Argumentos

hDbc
[Entrada] A alavanca de conexão.

hDbcInfoToken
[Entrada] O handle do token para a nova solicitação de conexão de aplicação.

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

Se wszOutConnectString for NULL, cchConnectStringLen ainda retornará o número total de caracteres (excluindo o caractere de terminação nula para dados de caracteres) disponíveis para retorno no buffer apontado por wszOutConnectString.

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

cchConnectStringLen
[Saída] Apontador para um buffer no qual retorna o número total de caracteres (excluindo o caractere de terminação nula) disponíveis para retorno em *wszOutConnectString. Se o número de caracteres disponíveis para retorno for maior ou igual a cchConnectStringBuffer, a cadeia de conexão completa em *wszOutConnectStringString é truncada para cchConnectStringBuffer menos o comprimento de um caractere de terminação nula.

Returns

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_ERROR, ou, SQL_INVALID_HANDLE.

Diagnostics

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

Remarks

O Driver Manager garante que o handle HENV pai do hDbc e do hDbcInfoToken sejam os mesmos.

Diferente do SQLDriverConnect, não há um argumento DriverCompletion para pedir aos usuários que insiram informações de conexão. Um diálogo de prompting é proibido no cenário de pooling.

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

Sempre que um driver retorna SQL_ERROR ou SQL_INVALID_HANDLE, o Gerenciador de Drivers retorna o erro para a aplicação (em SQLConnect ou SQLDriverConnect).

Sempre que um driver retorna SQL_SUCCESS_WITH_INFO, o Gerenciador de Drivers obterá as informações de diagnóstico do hDbcInfoToken e retornará SQL_SUCCESS_WITH_INFO para a aplicação no SQLConnect e SQLDriverConnect.

Quando uma aplicação usa SQLConnect, wszOutConnectString será um buffer NULL (os três últimos parâmetros serão todos definidos como NULL, 0, NULL). Caso contrário, o driver deve retornar a cadeia de conexão de saída, que será retornada à chamada da função SQLDriverConnect do aplicativo.

Incluir sqlspi.h para desenvolvimento de drivers ODBC.