Função SQLSetConnectAttrForDbcInfo

Conformidade
Versão Introduzida: ODBC 3.81 Conformidade com os Padronizados: ODBC

Summary
SQLSetConnectAttrForDbcInfo é o mesmo que SQLSetConnectAttr, mas define o atributo no token de informação de conexão em vez do handle.

Sintaxe

  
SQLRETURN  SQLSetConnectAttrForDbcInfo(  
                SQLHDBC_INFO_TOKEN    hDbcInfoToken,  
                SQLINTEGER            Attribute,  
                SQLPOINTER            ValuePtr,  
                SQLINTEGER            StringLength );

Argumentos

hDbcInfoToken
[Entrada] Nome de token.

Atributo
[Entrada] Atributo ao conjunto. A lista de atributos válidos é específica do driver e a mesma do SQLSetConnectAttr.

ValuePtr
[Entrada] Apontar para o valor a ser associado ao Atributo. Dependendo do valor de Attributo, ValuePtr será um valor inteiro não sinalado de 32 bits ou apontará para uma cadeia de caracteres terminada por nulo. Note que, se o argumento Atributo for um valor específico do driver, o valor em ValuePtr pode ser um inteiro com sinal.

Comprimento da cadeia de caracteres
[Entrada] Se Attribute for um atributo definido por ODBC e ValuePtr apontar para uma cadeia de caracteres ou um buffer binário, esse argumento deverá ter o comprimento de *ValuePtr. Para dados de cadeia de caracteres, esse argumento deve conter o número de bytes na cadeia.

Se Attribute for um atributo definido por ODBC e ValuePtr for um inteiro, StringLength será ignorado.

Se Attribute for um atributo definido pelo driver, o aplicativo indicará a natureza do atributo para o Gerenciador de Driver definindo o argumento StringLength . StringLength pode ter os seguintes valores:

  • Se ValuePtr for um ponteiro para uma cadeia de caracteres, StringLength será o comprimento da cadeia de caracteres ou SQL_NTS.

  • Se ValuePtr for um ponteiro para um buffer binário, o aplicativo colocará o resultado da macro SQL_LEN_BINARY_ATTR(length) em StringLength. Isso coloca um valor negativo em StringLength.

  • Se ValuePtr for um ponteiro para um valor diferente de uma cadeia de caracteres ou uma cadeia de caracteres binária, StringLength deverá ter o valor SQL_IS_POINTER.

  • Se ValuePtr contiver um valor de comprimento fixo, StringLength será SQL_IS_INTEGER ou SQL_IS_UINTEGER, conforme apropriado.

Returns

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_ERROR ou SQL_INVALID_HANDLE.

Diagnostics

O mesmo vale para SQLSetConnectAttr, exceto que o Gerenciador de Drivers usará um HandleType de SQL_HANDLE_DBC_INFO_TOKEN e um Handle de hDbcInfoToken.

Remarks

SQLSetConnectAttrForDbcInfo é o mesmo que SQLSetConnectAttr, mas define o atributo no token de informação de conexão, em vez de no handle de conexão. Por exemplo, se SQLSetConnectAttr não reconhecer um atributo, SQLSetConnectAttrForDbcInfo também deve retornar SQL_ERROR para esse atributo.

Sempre que o driver retorna SQL_ERROR ou SQL_INVALID_HANDLE, ele deve ignorar esse atributo para calcular o ID do pool. Além disso, 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. Portanto, uma aplicação pode recuperar detalhes sobre por que alguns atributos não podem ser definidos.

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.

Incluir sqlspi.h para desenvolvimento de drivers ODBC.

Conteúdo relacionado

  • Last updated on