Função SQLGetConnectAttr

Conformidade
Versão Introduzida: Normas ODBC 3.0 Conformidade: ISO 92

Summary
SQLGetConnectAttr devolve a definição atual de um atributo de ligação.

Syntax

  
SQLRETURN SQLGetConnectAttr(  
     SQLHDBC        ConnectionHandle,  
     SQLINTEGER     Attribute,  
     SQLPOINTER     ValuePtr,  
     SQLINTEGER     BufferLength,  
     SQLINTEGER *   StringLengthPtr);  

Arguments

ConnectionHandle
[Entrada] Alavanca de ligação.

Atributo
[Entrada] Atributo para recuperar.

ValuePtr
[Saída] Um apontador para a memória onde se deve devolver o valor atual do atributo especificado pelo Atributo. Para atributos do tipo inteiro, alguns drivers podem escrever apenas os 32 ou 16 bits inferiores de um buffer e deixar o bit de ordem superior inalterado. Portanto, as aplicações devem usar um buffer de SQLULEN e inicializar o valor a 0 antes de chamar esta função.

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

BufferLength
[Entrada] Se o Atributo for um atributo definido por ODBC e o ValuePtr apontar para uma cadeia de caracteres ou um buffer binário, este argumento deve corresponder ao comprimento de *ValuePtr. Se o Atributo for definido por ODBC e *ValuePtr for um inteiro, o BufferLength é ignorado. Se o valor em *ValuePtr for uma cadeia Unicode (ao chamar SQLGetConnectAttrW), o argumento BufferLength deve ser um número par.

Se o Atributo for um atributo definido pelo driver, a aplicação indica a natureza do atributo ao Driver Manager definindo o argumento BufferLength . BufferLength pode ter os seguintes valores:

• Se *ValuePtr for um ponteiro para uma cadeia de caracteres, BufferLength é o comprimento da cadeia.

• Se *ValuePtr for um ponteiro para um buffer binário, a aplicação coloca o resultado da macro SQL_LEN_BINARY_ATTR(comprimento) em BufferLength. Isto coloca um valor negativo no BufferLength.

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

• Se *ValuePtr contiver um tipo de dado de comprimento fixo, BufferLength é SQL_IS_INTEGER ou SQL_IS_UINTEGER, conforme apropriado.

StringLengthPtr
[Saída] Um apontador para um buffer onde deves o número total de bytes (excluindo o carácter de terminação nula) disponíveis para devolver em *ValuePtr. Se o valor do atributo for uma cadeia de caracteres e o número de bytes disponíveis para devolver for maior que BufferLength menos o comprimento do carácter de terminação nula, os dados em *ValuePtr são truncados para BufferLength menos o comprimento do carácter de terminação nula e são terminados por null pelo driver.

Devoluções

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_NO_DATA, SQL_ERROR ou SQL_INVALID_HANDLE.

Diagnósticos

Quando SQLGetConnectAttr devolve SQL_ERROR ou SQL_SUCCESS_WITH_INFO, pode ser obtido um valor SQLSTATE associado a partir da estrutura de dados de diagnóstico chamando SQLGetDiagRec com um HandleType de SQL_HANDLE_DBC e um Handle de ConnectionHandle. A tabela seguinte lista os valores SQLSTATE normalmente devolvidos pelo SQLGetConnectAttr e explica cada um no contexto desta função; a notação "(DM)" precede as descrições dos SQLSTATEs devolvidas pelo Gestor de Drivers. O código de retorno associado a cada valor SQLSTATE é SQL_ERROR, salvo indicação em contrário.

Comments

Para informações gerais sobre atributos de ligação, veja Atributos de Conexão.

Para uma lista de atributos que podem ser definidos, veja SQLSetConnectAttr. Note que, se o Atributo especificar um atributo que devolve uma cadeia, o ValuePtr deve ser um apontador para um buffer da cadeia. O comprimento máximo da cadeia devolvida, incluindo o carácter de terminação nula, será bytes BufferLength .

Dependendo do atributo, uma aplicação não precisa de estabelecer uma ligação antes de chamar SQLGetConnectAttr. No entanto, se o SQLGetConnectAttr for chamado e o atributo especificado não tiver um padrão e não tiver sido definido por uma chamada anterior ao SQLSetConnectAttr, o SQLGetConnectAttr devolverá SQL_NO_DATA.

Se o Atributo for SQL_ATTR_ TRACE ou SQL_ATTR_ TRACEFILE, o ConnectionHandle não tem de ser válido, e o SQLGetConnectAttr não devolverá SQL_ERROR ou SQL_INVALID_HANDLE se o ConnectionHandle for inválido. Estas características aplicam-se a todas as ligações. SQLGetConnectAttr devolverá SQL_ERROR ou SQL_INVALID_HANDLE se outro argumento for inválido.

Embora uma aplicação possa definir atributos de instrução usando SQLSetConnectAttr, uma aplicação não pode usar SQLGetConnectAttr para recuperar valores de atributos de instruções; deve chamar SQLGetStmtAttr para recuperar a definição dos atributos da instrução.

Tanto SQL_ATTR_AUTO_IPD como SQL_ATTR_CONNECTION_DEAD atributos de ligação podem ser devolvidos por uma chamada ao SQLGetConnectAttr , mas não podem ser definidos por uma chamada ao SQLSetConnectAttr.

Funções relacionadas

Conteúdo relacionado

• Referência da API ODBC
• Ficheiros de Cabeçalho ODBC