Função SQLGetPrivateProfileString

Compatibilidade
Versão introduzida: ODBC 2.0

Resumo
SQLGetPrivateProfileString obtém uma lista de nomes de valores ou dados correspondentes a um valor das informações do sistema.

Sintaxe

  
int SQLGetPrivateProfileString(  
     LPCSTR   lpszSection,  
     LPCSTR   lpszEntry,  
     LPCSTR   lpszDefault,  
     LPCSTR   RetBuffer,  
     INT      cbRetBuffer,  
     LPCSTR   lpszFilename);  

Argumentos

lpszSection
[Entrada] Aponta para uma cadeia de caracteres terminada em nulo que especifica a seção que contém o nome da chave. Se esse argumento for NULL, a função copiará todos os nomes de seção no arquivo para o buffer fornecido.

lpszEntry
[Entrada] Aponta para a cadeia de caracteres terminada em nulo que contém o nome da chave cuja cadeia de caracteres associada deve ser recuperada. Se esse argumento for NULL, todos os nomes de chave na seção especificada pelo argumento lpszSection serão copiados para o buffer especificado pelo argumento RetBuffer .

lpszDefault
[Entrada] Aponta para uma cadeia de caracteres terminada em nulo que especifica o valor padrão para a chave fornecida se a chave não puder ser encontrada no arquivo de inicialização. Esse argumento não pode ser NULL.

RetBuffer
[Saída] Aponta para o buffer que recebe a cadeia de caracteres recuperada.

cbRetBuffer
[Entrada] Especifica o tamanho, em caracteres, do buffer apontado pelo argumento RetBuffer .

lpszFilename
[Entrada] Aponta para uma cadeia de caracteres terminada em nulo que nomeia o arquivo de inicialização. Se esse argumento não contiver um caminho completo para o arquivo, o diretório padrão será pesquisado.

Retornos

SQLGetPrivateProfileString retorna um valor inteiro que indica o número de caracteres lidos.

Diagnósticos

Quando uma chamada para SQLGetPrivateProfileString falha, 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_OUT_OF_MEM	Memória insuficiente	O instalador não pôde executar a função devido à falta de memória.

Comentários

SQLGetPrivateProfileString é 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 GetPrivateProfileString que recuperam uma cadeia de caracteres de perfil do arquivo Odbc.ini devem ser substituídas por chamadas para SQLGetPrivateProfileString. SQLGetPrivateProfileString chama funções na API Win32 para recuperar os nomes solicitados de valores ou dados correspondentes a um valor da subchave Odbc.ini das informações do sistema.

O modo de configuração (conforme definido por SQLSetConfigMode) indica onde a entrada Odbc.ini listando valores DSN está nas informações do sistema. Se o DSN for um DSN de usuário (o modo de configuração é USERDSN_ONLY), a função será lida a partir da entrada Odbc.ini no HKEY_CURRENT_USER. Se o DSN for um DSN do sistema (SYSTEMDSN_ONLY), a função será lida a partir da entrada Odbc.ini no HKEY_LOCAL_MACHINE. Se o modo de configuração for BOTHDSN, HKEY_CURRENT_USER é tentado e, se falhar, HKEY_LOCAL_MACHINE é usado.

Funções relacionadas

Para obter informações sobre	Consulte
Gravando um valor nas informações do sistema	SQLWritePrivateProfileString