Compartilhar via

Função SQLWriteDSNToIni

  • Artigo

Conformidade
Versão introduzida: ODBC 1.0

Resumo
SQLWriteDSNToIni adiciona uma fonte de dados às informações do sistema.

Sintaxe

  
BOOL SQLWriteDSNToIni(  
     LPCSTR   lpszDSN,  
     LPCSTR   lpszDriver);

Argumentos

lpszDSN
[Entrada] Nome da fonte de dados a ser adicionada.

lpszDriver
[Entrada] Descrição do driver (geralmente o nome do DBMS associado) apresentada aos usuários em vez do nome do driver físico.

Retornos

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

Diagnósticos

Quando SQLWriteDSNToIni 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_GENERAL_ERR Erro geral do instalador Ocorreu um erro para o qual não houve nenhum erro específico do instalador.
ODBC_ERROR_INVALID_DSN DSN inválido O argumento lpszDSN continha uma cadeia de caracteres inválida para um DSN.
ODBC_ERROR_INVALID_NAME Nome do driver ou tradutor inválido O argumento lpszDriver era inválido.
ODBC_ERROR_REQUEST_FAILED Falha na solicitação O instalador não conseguiu criar um DSN no registro.
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

SQLWriteDSNToIni adiciona a fonte de dados à seção [Fontes de Dados ODBC] das informações do sistema. Em seguida, ele cria uma seção de especificação para a fonte de dados e adiciona uma única palavra-chave (Driver) com o nome da DLL do driver como seu valor. Se a seção de especificação da fonte de dados já existir, SQLWriteDSNToIni removerá a seção antiga antes de criar a nova.

O chamador dessa função deve adicionar quaisquer palavras-chave e valores específicos do driver à seção de especificação da fonte de dados das informações do sistema.

Se o nome da fonte de dados for Default, SQLWriteDSNToIni também criará a seção de especificação de driver padrão nas informações do sistema.

Essa função deve ser chamada somente de uma DLL de instalação.

Para obter informações sobre Consulte
Adicionar, modificar ou remover uma fonte de dados ConfigDSN(na DLL de Instalação)
Adicionar, modificar ou remover uma fonte de dados SQLConfigDataSource
Removendo um nome de fonte de dados das informações do sistema SQLRemoveDSNFromIni