Compartilhar via

Função SQLWriteFileDSN

  • Artigo

Conformidade
Versão introduzida: ODBC 3.0

Resumo
SQLWriteFileDSN grava informações em um DSN de Arquivo.

Sintaxe

  
BOOL SQLWriteFileDSN(  
     LPCSTR     lpszFileName,  
     LPCSTR     lpszAppName,  
     LPCSTR     lpszKeyName,  
     LPCSTR     lpszString);

Argumentos

lpszFileName
[Entrada] Ponteiro para o nome do DSN de Arquivo. Uma extensão DSN é acrescentada a todos os nomes de arquivo que ainda não têm uma extensão DSN.

lpszAppName
[Entrada] Ponteiro para o nome do aplicativo. Isso é "ODBC" para a seção ODBC.

lpszKeyName
[Entrada] Ponteiro para o nome da chave a ser lida. Confira "Comentários" para obter palavras-chave reservadas.

lpszString
[Saída] Apontou para a cadeia de caracteres associada à chave a ser gravada. O comprimento máximo da cadeia de caracteres apontada por esse argumento é de 32.767 bytes.

Retornos

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

Diagnósticos

Quando SQLWriteFileDSN 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_PATH Caminho de instalação inválido O caminho do nome do arquivo especificado no argumento lpszFileName era inválido.
ODBC_ERROR_INVALID_REQUEST_TYPE Tipo inválido de solicitação O argumento lpszAppName, lpszKeyName ou lpszString era NULL.

Comentários

O ODBC reserva o nome da seção [ODBC] no qual armazenar as informações de conexão. As palavras-chave reservadas para esta seção são as mesmas reservadas para uma cadeia de conexão no SQLDriverConnect. (Para obter mais informações, consulte a descrição da função SQLDriverConnect .)

Os aplicativos podem usar essas palavras-chave reservadas para gravar informações diretamente em um DSN de Arquivo. Se um aplicativo quiser criar ou modificar a cadeia de conexão sem DSN associada a um DSN de arquivo, ele poderá chamar SQLWriteFileDSN para qualquer uma das palavras-chave de cadeia de conexão reservadas na seção [ODBC].

Se o argumento lpszString for um ponteiro nulo, a palavra-chave apontada pelo argumento lpszKeyName será excluída do arquivo .dsn. Se os argumentos lpszString e lpszKeyName forem ponteiros nulos, a seção apontada pelo argumento lpszAppName será excluída do arquivo .dsn.

Para obter informações sobre Consulte
Lendo informações de DSNs de arquivo SQLReadFileDSN