Função SQLPoolConnect

Conformidade
Versão introduzida: ODBC 3.8 Standards Compliance: ODBC

Resumo
SQLPoolConnect é usado para criar uma nova conexão se nenhuma conexão no pool puder ser reutilizado.

Sintaxe

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

Argumentos

Hdbc
[Entrada] O identificador de conexão.

hDbcInfoToken
[Entrada] O identificador de token para a nova solicitação de conexão de aplicativo.

wszOutConnectString
[Saída] Ponteiro para um buffer para a cadeia de conexão concluída. Após a conexão bem-sucedida com a fonte de dados de destino, esse buffer contém a cadeia de conexão concluída. Os aplicativos 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 caractere) disponíveis para retornar no buffer apontado por wszOutConnectString.

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

cchConnectStringLen
[Saída] Ponteiro para um buffer no qual retornar o número total de caracteres (excluindo o caractere de terminação nula) disponível para retornar em *wszOutConnectString. Se o número de caracteres disponíveis para retornar for maior ou igual a cchConnectStringBuffer, a cadeia de conexão concluída em *wszOutConnectString será truncada para cchConnectStringBuffer menos o comprimento de um caractere de terminação nula.

Retornos

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_ERROR ou SQL_INVALID_HANDLE.

Diagnósticos

Semelhante a SQLDriverConnect para qualquer erro de validação de entrada, exceto que o Gerenciador de Driver usará um HandleType de SQL_HANDLE_DBC_INFO_TOKEN e um Identificador de hDbcInfoToken.

Comentários

O Gerenciador de Driver garante que o identificador HENV pai de hDbc e hDbcInfoToken seja o mesmo.

Ao contrário do SQLDriverConnect, não há nenhum argumento DriverCompletion para solicitar que os usuários insiram informações de conexão. Uma caixa de diálogo de solicitação não é permitida no cenário de pooling.

Os aplicativos não devem chamar essa função diretamente. Um driver ODBC que dá suporte ao pool de conexões com reconhecimento de driver deve implementar essa função.

Sempre que um driver retorna SQL_ERROR ou SQL_INVALID_HANDLE, o Gerenciador de Driver retorna o erro para o aplicativo (em SQLConnect ou SQLDriverConnect).

Sempre que um driver retornar SQL_SUCCESS_WITH_INFO, o Gerenciador de Driver obterá as informações de diagnóstico de hDbcInfoToken e retornará SQL_SUCCESS_WITH_INFO ao aplicativo em SQLConnect e SQLDriverConnect.

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

Inclua sqlspi.h para desenvolvimento de driver ODBC.

Consulte Também

Desenvolver um driver ODBC
Pool de conexões com reconhecimento de driver
Desenvolvimento um reconhecimento de pool de conexão em um driver ODBC