Função SQLSetConfigMode

Conformidade
Versão introduzida: ODBC 3.0

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

Sintaxe

  
BOOL SQLSetConfigMode(  
     UWORD     wConfigMode);  

Argumentos

wConfigMode
[Entrada] O modo de configuração do instalador (confira "Comentários"). O valor em wConfigMode 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 SQLSetConfigMode 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_INVALID_PARAM_SEQUENCE	Sequência de parâmetro inválida	O argumento wConfigMode não continha ODBC_USER_DSN, ODBC_SYSTEM_DSN ou ODBC_BOTH_DSN.

Comentários

Essa função é usada para definir onde a entrada Odbc.ini listando valores DSN está nas informações do sistema. Se wConfigMode 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.

Essa função não afeta SQLCreateDataSource e SQLDriverConnect. O modo de configuração deve ser definido quando um driver lê do registro chamando SQLGetPrivateProfileString ou grava no registro chamando SQLWritePrivateProfileString. As chamadas para SQLGetPrivateProfileString e SQLWritePrivateProfileString usam o modo de configuração para saber em qual parte do registro operar.

Cuidado

SQLSetConfigMode deve ser chamado somente quando necessário; se o modo estiver definido incorretamente, o Instalador ODBC poderá falhar ao funcionar corretamente.

SQLSetConfigMode faz uma modificação direta do registro do modo de configuração. Isso é diferente do processo de modificação do modo de configuração por uma chamada para SQLConfigDataSource. Uma chamada para SQLConfigDataSource define o modo de configuração para distinguir dSNs do usuário e do sistema ao modificar um DSN. Antes de retornar, SQLConfigDataSource redefine o modo de configuração para BOTHDSN.

Funções relacionadas

Para obter informações sobre	Consulte
Criando uma fonte de dados	SQLCreateDataSource
Conectando-se a uma fonte de dados usando uma cadeia de conexão ou caixa de diálogo	SQLDriverConnect
Recuperando o modo de configuração	SQLGetConfigMode