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

  • Статья

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

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

Синтаксис

UINT GetPrivateProfileInt(
  [in] LPCTSTR lpAppName,
  [in] LPCTSTR lpKeyName,
  [in] INT     nDefault,
  [in] LPCTSTR 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\CurrentVersion\IniFileMapping

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

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

  1. Найдите в реестре имя файла инициализации в разделе IniFileMapping .
  2. Найдите имя раздела, указанное в параметре lpAppName. Это будет именованное значение в ключе, которое имеет имя файла инициализации, или подраздел с этим именем, или имя не будет существовать в качестве значения или подраздела.
  3. Если имя раздела, указанное в параметре lpAppName , является именованным значением, то это значение указывает, где в реестре будут находиться разделы для раздела.
  4. Если имя раздела, указанное в параметре lpAppName , является подразделом, то именованные значения под этим подразделом указывают, где в реестре будут находиться ключи для раздела. Если ключ, который вы ищете, не существует как именованное значение, то будет неименованное значение (отображается как <Без имени>), указывающее расположение по умолчанию в реестре, где будет находиться ключ.
  5. Если имя раздела, указанное в параметре lpAppName , не существует в качестве именованного значения или подраздела, будет указано неименованное значение (без <имени>), указывающее расположение по умолчанию в реестре, где будут находиться ключи для раздела.
  6. Если для имени раздела нет подраздела или записи, найдите фактический файл инициализации на диске и считайте его содержимое.
При просмотре значений в реестре, указывающих другие расположения реестра, существует несколько префиксов, которые изменяют поведение сопоставления файлов .ini:
  • ! — этот символ заставляет все операции записи идти как в реестр, так и в файл .ini на диске.
  • # — этот символ определяет значение реестра в файле .ini Windows 3.1 при первом входе нового пользователя после установки.
  • @ — этот символ предотвращает любые операции чтения в файл .ini на диске, если запрошенные данные не найдены в реестре.
  • USR: этот префикс означает HKEY_CURRENT_USER, а текст после префикса находится относительно этого ключа.
  • SYS: этот префикс означает HKEY_LOCAL_MACHINE\SOFTWARE, а текст после префикса находится относительно этого ключа.

Требования

Требование Значение
Минимальная версия клиента Windows 2000 Professional [только классические приложения]
Минимальная версия сервера Windows 2000 Server [только классические приложения]
Целевая платформа Windows
Header winbase.h (включая Windows.h)
Библиотека Kernel32.lib
DLL Kernel32.dll

См. также

GetProfileInt

WritePrivateProfileString