Função SQLGetConfigMode

Conformidade
Versão introduzida: ODBC 3.0

Resumo
SQLGetConfigMode recupera o modo de configuração que indica onde a entrada Odbc.ini listando valores DSN está nas informações do sistema.

Sintaxe

  
BOOL SQLGetConfigMode(  
     UWORD *   pwConfigMode);  

Argumentos

pwConfigMode
[Saída] Ponteiro para o buffer que contém o modo de configuração. (Confira "Comentários".) O valor em *pwConfigMode pode ser:

ODBC_USER_DSN

ODBC_SYSTEM_DSN

ODBC_BOTH_DSN

Retornos

A função retornará TRUE se for bem-sucedida, FALSE se falhar.

Diagnósticos

Quando SQLGetConfigMode retorna FALSE, um valor *pfErrorCode associado pode ser obtido chamando SQLInstallerError. A tabela a seguir lista os valores *pfErrorCode que podem ser retornados por SQLInstallerError e explica cada um deles no contexto dessa função.

*pfErrorCode	Erro	Descrição
ODBC_ERROR_OUT_OF_MEM	Memória insuficiente	O instalador não pôde executar a função devido à falta de memória.

Comentários

Essa função é usada para determinar onde a entrada Odbc.ini listando valores DSN está nas informações do sistema. Se *pwConfigMode for ODBC_USER_DSN, o DSN será um DSN de usuário e a função lerá a partir da entrada Odbc.ini no HKEY_CURRENT_USER. Se for ODBC_SYSTEM_DSN, o DSN será um DSN do Sistema e a função lerá a partir da entrada Odbc.ini no HKEY_LOCAL_MACHINE. Se for ODBC_BOTH_DSN, HKEY_CURRENT_USER será tentado e, se falhar, HKEY_LOCAL_MACHINE será usado.

Por padrão, SQLGetConfigMode retorna ODBC_BOTH_DSN. Quando um DSN de usuário ou um DSN do sistema é criado por uma chamada para SQLConfigDataSource, a função define o modo de configuração como ODBC_USER_DSN ou ODBC_SYSTEM_DSN para distinguir DSNs do usuário e do sistema ao modificar um DSN. Antes de retornar, SQLConfigDataSource redefine o modo de configuração para ODBC_BOTH_DSN.

Funções relacionadas

Para obter informações sobre	Consulte
Definindo o modo de configuração	SQLSetConfigMode