Função SQLWritePrivateProfileString

Compatibilidade
Versão introduzida: ODBC 2.0

Resumo
SQLWritePrivateProfileString grava um nome de valor e dados na subchave Odbc.ini das informações do sistema.

Sintaxe

  
BOOL SQLWritePrivateProfileString(  
     LPCSTR     lpszSection,  
     LPCSTR     lpszEntry,  
     LPCSTR     lpszString,  
     LPCSTR     lpszFilename);  

Argumentos

lpszSection
[Entrada] Aponta para uma cadeia de caracteres terminada em nulo que contém o nome da seção para a qual a cadeia de caracteres será copiada. Se a seção não existir, ela será criada. O nome da seção é independente de maiúsculas e minúsculas; A cadeia de caracteres pode ser qualquer combinação de letras maiúsculas e minúsculas.

lpszEntry
[Entrada] Aponta para uma cadeia de caracteres terminada em nulo que contém o nome da chave a ser associada a uma cadeia de caracteres. Se a chave não existir na seção especificada, ela será criada. Se esse argumento for NULL, a seção inteira, incluindo todas as entradas dentro da seção, será excluída.

lpszString
[Entrada] Aponta para uma cadeia de caracteres terminada em nulo a ser gravada no arquivo. Se esse argumento for NULL, a chave apontada pelo argumento lpszEntry será excluída.

lpszFilename
[Saída] Aponta para uma cadeia de caracteres terminada em nulo que nomeia o arquivo de inicialização.

Retornos

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

Diagnósticos

Quando SQLWritePrivateProfileString 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 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_REQUEST_FAILED	Falha na solicitação	As informações do sistema solicitadas não puderam ser gravadas.
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

SQLWritePrivateProfileString é fornecido como uma maneira simples de portar drivers e DLLs de instalação de driver do Microsoft Windows para o Microsoft Windows NT/Windows 2000. As chamadas para WritePrivateProfileString que gravam uma cadeia de caracteres de perfil no arquivo Odbc.ini devem ser substituídas por chamadas para SQLWritePrivateProfileString. SQLWritePrivateProfileString chama funções na API Win32 para adicionar o nome do valor especificado e os dados à subchave Odbc.ini das informações do sistema.

Um modo de configuração indica onde a entrada Odbc.ini listando valores DSN está nas informações do sistema. Se o DSN for um DSN de usuário (a variável de estado é USERDSN_ONLY), a função grava na entrada Odbc.ini em HKEY_CURRENT_USER. Se o DSN for um DSN do sistema (SYSTEMDSN_ONLY), a função grava na entrada Odbc.ini no HKEY_LOCAL_MACHINE. Se a variável de estado for BOTHDSN, HKEY_CURRENT_USER será tentada e, se falhar, HKEY_LOCAL_MACHINE será usada.

Funções relacionadas

Para obter informações sobre	Consulte
Obtendo um valor das informações do sistema	SQLGetPrivateProfileString