Função GetPrivateProfileInt (winbase.h)
Recupera um inteiro associado a uma chave na seção especificada de um arquivo de inicialização.
Sintaxe
UINT GetPrivateProfileInt(
[in] LPCTSTR lpAppName,
[in] LPCTSTR lpKeyName,
[in] INT nDefault,
[in] LPCTSTR lpFileName
);
Parâmetros
[in] lpAppName
O nome da seção no arquivo de inicialização.
[in] lpKeyName
O nome da chave cujo valor deve ser recuperado. Esse valor está na forma de uma cadeia de caracteres; a função GetPrivateProfileInt converte a cadeia de caracteres em um inteiro e retorna o inteiro.
[in] nDefault
O valor padrão a ser retornado se o nome da chave não puder ser encontrado no arquivo de inicialização.
[in] lpFileName
O nome do arquivo de inicialização. Se esse parâmetro não contiver um caminho completo para o arquivo, o sistema pesquisa o arquivo no diretório do Windows.
Retornar valor
O valor retornado é o equivalente inteiro da cadeia de caracteres após o nome da chave especificado no arquivo de inicialização especificado. Se a chave não for encontrada, o valor retornado será o valor padrão especificado.
Comentários
A função pesquisa no arquivo uma chave que corresponda ao nome especificado pelo parâmetro lpKeyName sob o nome da seção especificado pelo parâmetro lpAppName . Uma seção no arquivo de inicialização deve ter o seguinte formato:
[section]
key=value
.
.
.
A função GetPrivateProfileInt não diferencia maiúsculas de minúsculas; as cadeias de caracteres em lpAppName e lpKeyName podem ser uma combinação de letras maiúsculas e minúsculas.
Um aplicativo pode usar a função GetProfileInt para recuperar um valor inteiro do arquivo Win.ini.
O sistema mapeia a maioria das referências de arquivo .ini para o registro, usando o mapeamento definido na seguinte chave do Registro:HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\IniFileMapping
Esse mapeamento provavelmente será se um aplicativo modificar arquivos de inicialização de componente do sistema, como Control.ini, System.ini e Winfile.ini. Nesses casos, a função recupera informações do registro, não do arquivo de inicialização; a alteração no local de armazenamento não tem efeito sobre o comportamento da função.
As funções de perfil usam as seguintes etapas para localizar informações de inicialização:
- Procure no Registro o nome do arquivo de inicialização na chave IniFileMapping .
- Procure o nome da seção especificado por lpAppName. Esse será um valor nomeado sob a chave que tem o nome do arquivo de inicialização ou uma subchave com esse nome ou o nome não existirá como um valor ou subchave.
- Se o nome da seção especificado por lpAppName for um valor nomeado, esse valor especificará onde, no Registro, você encontrará as chaves da seção.
- Se o nome da seção especificado por lpAppName for uma subchave, os valores nomeados nessa subchave especificarão onde, no Registro, você encontrará as chaves da seção. Se a chave que você está procurando não existir como um valor nomeado, haverá um valor sem nome (mostrado como <Nenhum Nome>) que especifica o local padrão no registro em que você encontrará a chave.
- Se o nome da seção especificado por lpAppName não existir como um valor nomeado ou como uma subchave, haverá um valor sem nome (mostrado como <Nenhum Nome>) que especifica o local padrão no registro em que você encontrará as chaves da seção.
- Se não houver subchave ou entrada para o nome da seção, procure o arquivo de inicialização real no disco e leia seu conteúdo.
- ! – esse caractere força todas as gravações a ir para o registro e para o arquivo .ini no disco.
- # – esse caractere faz com que o valor do Registro seja definido como o valor no arquivo de .ini do Windows 3.1 quando um novo usuário fizer logon pela primeira vez após a instalação.
- @ – esse caractere impede que as leituras acessem o arquivo de .ini no disco se os dados solicitados não forem encontrados no registro.
- USR: – esse prefixo significa HKEY_CURRENT_USER e o texto após o prefixo é relativo a essa chave.
- SYS: - esse prefixo significa HKEY_LOCAL_MACHINE\SOFTWAREe o texto após o prefixo é relativo a essa chave.
Requisitos
| Requisito | Valor |
|---|---|
| Cliente mínimo com suporte | Windows 2000 Professional [somente aplicativos da área de trabalho] |
| Servidor mínimo com suporte | Windows 2000 Server [somente aplicativos da área de trabalho] |
| Plataforma de Destino | Windows |
| Cabeçalho | winbase.h (incluir Windows.h) |
| Biblioteca | Kernel32.lib |
| DLL | Kernel32.dll |