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

Статья
03/08/2023

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

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

Синтаксис

DWORD GetProfileStringA(
  [in]  LPCSTR lpAppName,
  [in]  LPCSTR lpKeyName,
  [in]  LPCSTR lpDefault,
  [out] LPSTR  lpReturnedString,
  [in]  DWORD  nSize
);

Параметры

[in] lpAppName

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

[in] lpKeyName

Имя ключа, связанная строка которого требуется извлечь. Если этот параметр имеет значение NULL, функция копирует все ключи в заданном разделе в предоставленный буфер. За каждой строкой следует символ NULL , а за последней строкой — второй символ NULL .

[in] lpDefault

Строка по умолчанию. Если ключ lpKeyName не найден в файле инициализации, GetProfileString копирует строку по умолчанию в буфер lpReturnedString . Если этот параметр имеет значение NULL, по умолчанию используется пустая строка "".

Не указывайте строку по умолчанию с конечными пустыми символами. Функция вставляет пустой символ в буфер lpReturnedString для удаления всех конечных пробелов.

[out] lpReturnedString

Указатель на буфер, получающий символьную строку.

[in] nSize

Размер буфера, на который указывает параметр lpReturnedString , в символах.

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

Возвращаемое значение — это количество символов, скопированных в буфер, не включая символ конца null.

Если ни lpAppName, ни lpKeyName не имеют значения NULL , а предоставленный буфер назначения слишком мал для хранения запрошенной строки, строка усекается и за ней следует символ NULL , а возвращаемое значение равно nSize минус единица.

Если lpAppName или lpKeyName имеет значение NULL и предоставленный буфер назначения слишком мал для хранения всех строк, последняя строка усекается и за ней следуют два символа NULL . В этом случае возвращаемое значение равно nSize минус два.

Windows Server 2003 и Windows XP/2000: Вызовы функций профиля могут быть сопоставлены с реестром, а не с файлами инициализации. Это сопоставление возникает, когда файл и раздел инициализации указаны в реестре в следующих разделах:

HKEY_LOCAL_MACHINE\Программного обеспечения\Microsoft\\ Windows NT CurrentVersion\IniFileMapping

После сопоставления операции функция GetProfileString извлекает сведения из реестра, а не из файла инициализации; Изменение расположения хранилища не влияет на поведение функции.

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

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

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

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

Примечание

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

Требования

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

См. также

GetPrivateProfileString

WriteProfileString