Função GetPrivateProfileIntA (winbase.h)

Artigo
11/20/2024

Recupera um inteiro associado a uma chave na seção especificada de um arquivo de inicialização.

Observação Essa função é fornecida apenas para compatibilidade com aplicativos baseados no Windows de 16 bits. Os aplicativos devem armazenar informações de inicialização no registro.

Sintaxe

UINT GetPrivateProfileIntA(
  [in] LPCSTR lpAppName,
  [in] LPCSTR lpKeyName,
  [in] INT    nDefault,
  [in] LPCSTR 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 procurará o arquivo no diretório do Windows.

Valor de retorno

O valor retornado é o equivalente inteiro da cadeia de caracteres seguindo 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.

Observações

A função pesquisa no arquivo uma chave que corresponde 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 formulário:

[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 sob a seguinte chave do Registro:HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\\CurrentVersion\IniFileMapping

Esse mapeamento provavelmente será modificado se um aplicativo modificar arquivos de inicialização do componente do sistema, como Control.ini, System.inie 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 sob essa 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 não nomeado (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 especificará o local padrão no registro em que você encontrará as chaves da seção.
Se não houver nenhuma subchave ou entrada para o nome da seção, procure o arquivo de inicialização real no disco e leia seu conteúdo.

Ao examinar os valores no registro que especificam outros locais do Registro, há vários prefixos que alteram o comportamento do mapeamento de arquivo .ini:

! - esse caractere força todas as gravações a ir para o registro e para o arquivo .ini em 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 qualquer leitura vá para o arquivo .ini em disco se os dados solicitados não forem encontrados no registro.
USR: - esse prefixo significa HKEY_CURRENT_USERe 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.

Nota

O cabeçalho winbase.h define GetPrivateProfileInt como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante do pré-processador UNICODE. A combinação do uso do alias neutro de codificação com código que não é neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Conventions for Function Prototypes.

Requisitos

Requisito	Valor
de cliente com suporte mínimo	Windows 2000 Professional [somente aplicativos da área de trabalho]
servidor com suporte mínimo	Windows 2000 Server [somente aplicativos da área de trabalho]
da Plataforma de Destino	Windows
cabeçalho	winbase.h (inclua Windows.h)
biblioteca	Kernel32.lib
de DLL	Kernel32.dll

Consulte também

GetProfileInt

WritePrivateProfileString

Compartilhar via