Функция GetPrivateProfileIntA (winbase.h)

Статья
11/20/2024

Извлекает целое число, связанное с ключом в указанном разделе файла инициализации.

Примечание Эта функция предоставляется только для совместимости с 16-разрядными приложениями windows. Приложения должны хранить сведения о инициализации в реестре.

Синтаксис

UINT GetPrivateProfileIntA(
  [in] LPCSTR lpAppName,
  [in] LPCSTR lpKeyName,
  [in] INT    nDefault,
  [in] LPCSTR lpFileName
);

Параметры

[in] lpAppName

Имя раздела в файле инициализации.

[in] lpKeyName

Имя ключа, значение которого требуется извлечь. Это значение находится в виде строки; функция getPrivateProfileInt преобразует строку в целое число и возвращает целое число.

[in] nDefault

Значение по умолчанию, возвращаемое, если имя ключа не удается найти в файле инициализации.

[in] lpFileName

Имя файла инициализации. Если этот параметр не содержит полный путь к файлу, система ищет файл в каталоге Windows.

Возвращаемое значение

Возвращаемое значение является целочисленным эквивалентом строки после указанного имени ключа в указанном файле инициализации. Если ключ не найден, возвращаемое значение является указанным значением по умолчанию.

Замечания

Функция выполняет поиск файла ключа, соответствующего имени, заданного параметром lpKeyName под именем раздела, указанным параметром lpAppName. Раздел в файле инициализации должен иметь следующую форму:

[section]
key=value
      .
      .
      .

Функция GetPrivateProfileInt не учитывает регистр; Строки в lpAppName и lpKeyName могут быть сочетанием строчных и строчных букв.

Приложение может использовать функцию getProfileInt для получения целочисленного значения из файла Win.ini.

Система сопоставляет большинство .ini ссылок на файл реестра, используя сопоставление, определенное в следующем разделе реестра:HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT NT\CurrentVersion\IniFileMapping

Это сопоставление вероятно, если приложение изменяет файлы инициализации системного компонента, например Control.ini, System.iniи Winfile.ini. В таких случаях функция извлекает сведения из реестра, а не из файла инициализации; Изменение расположения хранилища не влияет на поведение функции.

Функции профиля используют следующие действия для поиска сведений о инициализации:

Найдите в реестре имя файла инициализации в ключа IniFileMapping.
Найдите имя раздела, указанное lpAppName. Это будет именованное значение под ключом, которое имеет имя файла инициализации, или подраздел с этим именем, или имя не будет существовать как значение или вложенный ключ.
Если имя раздела, указанное lpAppName является именованным значением, то это значение указывает, где в реестре будут находиться ключи для раздела.
Если имя раздела, указанное lpAppName является вложенным ключом, то именованные значения в этом подразделе указывают, где в реестре будут находиться ключи для раздела. Если ключ, который вы ищете, не существует в качестве именованного значения, то будет неименованное значение (показано как <No Name>), указывающее расположение по умолчанию в реестре, где будет находиться ключ.
Если имя раздела, указанное lpAppName, не существует в качестве именованного значения или в качестве подраздела, то будет неименованное значение (показано как <no Name>), указывающее расположение по умолчанию в реестре, где будут находиться ключи раздела.
Если для имени раздела нет подраздела или записи, найдите фактический файл инициализации на диске и считывает его содержимое.

При просмотре значений в реестре, определяющих другие расположения реестра, существует несколько префиксов, которые изменяют поведение сопоставления файлов .ini:

! — этот символ заставляет все записи переходить как в реестр, так и в файл .ini на диске.
# — этот символ приводит к тому, что значение реестра должно быть задано в файле Windows 3.1 .ini при первом входе пользователя в систему.
@ — этот символ запрещает чтение в файл .ini на диске, если запрошенные данные не найдены в реестре.
USR: — этот префикс обозначает HKEY_CURRENT_USER, а текст после префикса относительно этого ключа.
SYS: — этот префикс обозначает HKEY_LOCAL_MACHINE\SOFTWAREи текст после префикса относительно этого ключа.

Заметка

Заголовок winbase.h определяет GetPrivateProfileInt как псевдоним, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОДа. Сочетание использования псевдонима, нейтрального для кодирования, с кодом, не зависящим от кодирования, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в соглашениях о прототипах функций.

Требования

Требование	Ценность
минимальные поддерживаемые клиентские	Windows 2000 Профессиональный [только классические приложения]
минимальный поддерживаемый сервер	Windows 2000 Server [только классические приложения]
целевая платформа	Виндоус
заголовка	winbase.h (включая Windows.h)
библиотеки	Kernel32.lib
DLL	Kernel32.dll

См. также

GetProfileInt

WritePrivateProfileString

Поделиться через