На главную

On-line справка по Win32 API

Написать письмо
БЕСПЛАТНАЯ ежедневная online лотерея! Выигрывай каждый день БЕСПЛАТНО!
Список всех статей A-B-C-D-E-F-G-H-I-J-K-L-M-N-O-P-Q-R-S-T-U-V-W-X-Y-Z | Скачать Вниз

GetPrivateProfileString



The GetPrivateProfileString function retrieves a string from the specified section in an initialization file. This function is provided for compatibility with 16-bit Windows-based applications. Win32-based applications should store initialization information in the registry.

DWORD GetPrivateProfileString(

LPCTSTR lpAppName, // points to section name
LPCTSTR lpKeyName, // points to key name
LPCTSTR lpDefault, // points to default string
LPTSTR lpReturnedString, // points to destination buffer
DWORD nSize, // size of destination buffer
LPCTSTR lpFileName // points to initialization filename
);


Parameters

lpAppName

Points to a null-terminated string that specifies the section containing the key name. If this parameter is NULL, the GetPrivateProfileString function copies all section names in the file to the supplied buffer.

lpKeyName

Pointer to the null-terminated string containing the key name whose associated string is to be retrieved. If this parameter is NULL, all key names in the section specified by the lpAppName parameter are copied to the buffer specified by the lpReturnedString parameter.

lpDefault

Pointer to a null-terminated default string. If the lpKeyName key cannot be found in the initialization file, GetPrivateProfileString copies the default string to the lpReturnedString buffer. This parameter cannot be NULL.
Avoid specifying a default string with trailing blank characters. The function inserts a null character in the lpReturnedString buffer to strip any trailing blanks.
Windows 95: Although lpDefault is declared as a constant parameter, Windows 95 strips any trailing blanks by inserting a null character into the lpDefault string before copying it to the lpReturnedString buffer.

Windows NT: Windows NT does not modify the lpDefault string. This means that if the default string contains trailing blanks, the lpReturnedString and lpDefault strings will not match when compared using the lstrcmp function.

lpReturnedString

Pointer to the buffer that receives the retrieved string.

nSize

Specifies the size, in characters, of the buffer pointed to by the lpReturnedString parameter.

lpFileName

Pointer to a null-terminated string that names the initialization file. If this parameter does not contain a full path to the file, Windows searches for the file in the Windows directory.



Return Values

If the function succeeds, the return value is the number of characters copied to the buffer, not including the terminating null character.
If neither lpAppName nor lpKeyName is NULL and the supplied destination buffer is too small to hold the requested string, the string is truncated and followed by a null character, and the return value is equal to nSize minus one.
If either lpAppName or lpKeyName is NULL and the supplied destination buffer is too small to hold all the strings, the last string is truncated and followed by two null characters. In this case, the return value is equal to nSize minus two.

Remarks

The GetPrivateProfileString function searches the specified initialization file for a key that matches the name specified by the lpKeyName parameter under the section heading specified by the lpAppName parameter. If it finds the key, the function copies the corresponding string to the buffer. If the key does not exist, the function copies the default character string specified by the lpDefault parameter. A section in the initialization file must have the following form:

[section]
key=string
.
.
.
If lpAppName is NULL, GetPrivateProfileString copies all section names in the specified file to the supplied buffer. If lpKeyName is NULL, the function copies all key names in the specified section to the supplied buffer. An application can use this method to enumerate all of the sections and keys in a file. In either case, each string is followed by a null character and the final string is followed by a second null character. If the supplied destination buffer is too small to hold all the strings, the last string is truncated and followed by two null characters.

If the string associated with lpKeyName is enclosed in single or double quotation marks, the marks are discarded when the GetPrivateProfileString function retrieves the string.
The GetPrivateProfileString function is not case-sensitive; the strings can be a combination of uppercase and lowercase letters.
To retrieve a string from the WIN.INI file, use the GetProfileString function.

Windows NT:

Calls to private profile functions may be mapped to the registry instead of to the specified initialization files. This mapping occurs when the initialization file and section are specified in the registry under the following keys:
HKEY_LOCAL_MACHINE\Software\Microsoft\
Windows NT\CurrentVersion\IniFileMapping
This mapping is likely if an application modifies system-component initialization files, such as CONTROL.INI, SYSTEM.INI, and WINFILE.INI. In these cases, the GetPrivateProfileString function retrieves information from the registry, not from the initialization file; the change in the storage location has no effect on the function's behavior.

The Win32 Profile functions (Get/WriteProfile*, Get/WritePrivateProfile*) use the following steps to locate initialization information:

1. Look in the registry for the name of the initialization file, say myfile.ini, under IniFileMapping:

HKEY_LOCAL_MACHINE\Software\Microsoft\
Windows NT\CurrentVersion\IniFileMapping\myfile.ini

2. Look for the section name specified by lpAppName. This will be a named value under myfile.ini, or a subkey of myfile.ini, or will not exist.
3. If the section name specified by lpAppName is a named value under myfile.ini, then that value specifies where in the registry you will find the keys for the section.
4. If the section name specified by lpAppName is a subkey of myfile.ini, then named values under that subkey specify where in the registry you will find the keys for the section. If the key you are looking for does not exist as a named value, then there will be an unnamed value (shown as "") that specifies the default location in the registry where you will find the key.

5. If the section name specified by lpAppName does not exist as a named value or as a subkey under myfile.ini, then there will be an unnamed value (shown as "") under myfile.ini that specifies the default location in the registry where you will find the keys for the section.
6. If there is no subkey for myfile.ini, or if there is no entry for the section name, then look for the actual myfile.ini on the disk and read its contents.

When looking at values in the registry that specify other registry locations, there are several prefixes that change the behavior of the ini file mapping:
! - this character forces all writes to go both to the registry and to the .INI file on disk.
# - this character causes the registry value to be set to the value in the Windows 3.1 .INI file when a new user logs in for the first time after setup.
@ - this character prevents any reads from going to the .INI file on disk if the requested data is not found in the registry.

USR: - this prefix stands for HKEY_CURRENT_USER, and the text after the prefix is relative to that key.
SYS: - this prefix stands for HKEY_LOCAL_MACHINE\SOFTWARE, and the text after the prefix is relative to that key.



See Also

GetProfileString, WritePrivateProfileString


Пригласи друзей и счет твоего мобильника всегда будет положительным!
Предыдущая статья
 
Сайт Народ.Ру Интернет
Следующая статья
Пригласи друзей и счет твоего мобильника всегда будет положительным!

GetPrivateProfileString



Функция GetPrivateProfileString извлекает строку из определенной секции в файле инициализации. Эта функция предусмотрена для совместимости 16- битом основавшим приложения Окна. базирующиеся приложения Win32 должны загружать информацию инициализации в регистрацию.

DWORD GetPrivateProfileString(

LPCTSTR lpAppName, // ТОЧКИ на имя секции LPCTSTR lpKeyName, // точки на ключевое имя LPCTSTR lpDefault, // точки, чтобы нарушать обязательства строку LPTSTR lpReturnedString, // точки на буфер расположения DWORD nSize, // размер буфера расположения LPCTSTR lpFileName // точки на инициализацию filename
);


Параметры

lpAppName

Точки на недействительный расторгнутую строку, которые определяют секцию, содержащую ключевое имя. Если этот параметр НЕДЕЙСТВИТЕЛЕН, функция GetPrivateProfileString копирует все имена секции в файле в поставленный буфер.

lpKeyName

Указатель в недействительный расторгнутую строку, содержащую ключевое имя чье связавшее строку должно быть извлечено. Если этот параметр НЕДЕЙСТВИТЕЛЕН, вся клавиша называется в секции определенной параметром lpAppName скопированы в буфер определенный lpReturnedString параметром.

lpDefault

Указатель в недействительный расторгнутую по умолчанию строку. Если клавиша lpKeyName не может быть обнаружена в файле инициализации, GetPrivateProfileString копирует по умолчанию строку в буфер lpReturnedString. Этот параметр не может быть НЕДЕЙСТВИТЕЛЕН.
Избегайте определять по умолчанию строку с конечными чистыми символами. Функция включает недействительный символ в lpReturnedString буфер, чтобы удалять любые конечные пробелы.
Windows 95: Хотя lpDefault объявлен как постоянный параметр, полосы Windows 95 любых конечных пробелов включая недействительный символ в строку lpDefault перед копированием это в буфер lpReturnedString.

Windows NT: Windows NT не модифицирует строку lpDefault. Это означает, что если по умолчанию строка содержит конечные пробелы, lpReturnedString и строки lpDefault не сочетается когда сравнено используя функцию lstrcmp.

lpReturnedString

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

nSize

Определяет размер, в символах, буфера указанного, чтобы lpReturnedString параметром.

lpFileName

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



Обратные Величины

Если функция добивается успеха, обратная величина является количеством символов скопированных в буфер, не включая завершающий недействительный символ.
Если ни lpAppName ни lpKeyName НЕДЕЙСТВИТЕЛЕН и поставленный буфер расположения слишком небольшой, чтобы держать запрошенную строку, строка исключена и сопровождена недействительным символом, и обратная величина равняется nSize минус одно.
Если или lpAppName или lpKeyName НЕДЕЙСТВИТЕЛЕН и поставленный буфер расположения слишком небольшой, чтобы держать все строки, последняя строка исключена и сопровождена двумя недействительными символами. В этом случае, обратная величина равняется nSize минус два.

Замечания

Функция GetPrivateProfileString ищет определенный файл инициализации для клавиши, которая соответствует имени определялся параметром lpKeyName под секцией, возглавляющей определенное параметром lpAppName. Если это находит клавишу, функция копирует соответствующую строку в буфер. Если клавиша не существует, функция копирует по умолчанию символьную строку определенную параметром lpDefault. Секция в файле инициализации должна иметь следующее формы:

[section] key=string
.
.
.
Если lpAppName НЕДЕЙСТВИТЕЛЕН, GetPrivateProfileString копирует все имена секции в определенном файле в поставленный буфер. Если lpKeyName НЕДЕЙСТВИТЕЛЕН, функция копирует все ключевые имена в определенной секции в поставленный буфер. Приложение может использовать этот метод, чтобы перечислять все секции и клавиши в файле. В любом случае, каждая строка следует за недействительным символом и конечная строка следует за недействительным символом секунды. Если поставленный буфер расположения слишком небольшой, чтобы держать все строки, последняя строка исключена и сопровождена двумя недействительными символами.

Если строка связанная lpKeyName приложена в единственном или двойные кавычки, отметки отвергнуты когда функция GetPrivateProfileString извлекает строку.
Функция GetPrivateProfileString не случай-чувствительная; строки могут быть комбинация верхнего регистра писем и верхнего регистра.
Для того, чтобы извлекать строку из файла WIN.INI, используйте функцию GetProfileString.

Windows NT:

Вызовы в частные функции профиля могут быть отображены в регистрацию а не в определенные файлы инициализации. Это распределение происходит когда файл инициализации и секции определены в регистрации под следующими клавишами: HKEY_LOCAL_MACHINE\Software\Microsoft\ Windows NT\CurrentVersion\IniFileMapping Этого распределения вероятное если приложение модифицирует системные-компонентные файлы инициализации, как например, CONTROL.INI, SYSTEM.INI, и WINFILE.INI. В этих случаях, функция GetPrivateProfileString извлекает информацию из регистрации, не из файла инициализации; изменение в позиции памяти не имеет эффект в функциональном поведении.

Профиль Win32 функционирует (Get/WriteProfile*, Get/WritePrivateProfile*), использовать следующее шагов, чтобы располагать информацию инициализации:

1. Посмотрите регистрацию для имени файла инициализации, говорить myfile.ini, под IniFileMapping:

HKEY_LOCAL_MACHINE\Software\Microsoft\ Windows NT\CurrentVersion\IniFileMapping\myfile.ini

2. Поищите имя секции определенное lpAppName. Это будет поименованной величиной под myfile.ini, или подключом myfile.ini, или не просуществует.
3. Если имя секции определенное lpAppName - поименованная величина под myfile.ini, тогда эта величина определяется где в регистрации, Вы найдете клавиши для секции.
4. Если имя секции определенное lpAppName - подключ myfile.ini, тогда назвавшее величины под этим подключом определяться где в регистрации, Вы найдете клавиши для секции. Если клавиша Вы - искать не существует как поименованная величина, тогда найдется безымянная величина (показанное как ""), что определяет по умолчанию позицию в регистрации где Вы найдете клавишу.

5. Если имя секции определялось бы lpAppName не существует как поименованная величина или как подключ под myfile.ini, тогда найдется безымянная величина (показанное как "") под myfile.ini, которое определяет по умолчанию позицию в регистрации где Вы найдете клавиши для секции.
6. Если нет подключа для myfile.ini, или если нет входа для имени секции, тогда поищите фактический myfile.ini на диске и читайте свое содержание.

При рассмотрении в величинах в регистрации, которая определяет другие позиции регистрации, есть несколько префиксов, который изменяет поведение ini файлового распределения:
! - эти символьные силы все записывают, чтобы ходить как в регистрацию так и в файл .INI на диске.
# - этот символ заставляет величину регистрации, чтобы быть установленн в величину в файле Windows 3.1 .INI когда новый пользователь регистрируется в впервые после установки.
@ - этот символ предохраняет любое читается чтобы ходить в файл .INI на диске если запрошенные данные не обнаружены в регистрации.

USR: - ЭТО префиксный представляющие HKEY_CURRENT_USER, и текст после того, как префикс будет относительно этой клавиши.
SYS: - ЭТО префиксный представляющие HKEY_LOCAL_MACHINE\SOFTWARE, и текст после того, как префикс будет относительно этой клавиши.



Смотри Также

GetProfileString, WritePrivateProfileString


Вверх Version 1.3, Oct 26 2010 © 2007, 2010, mrhx Вверх
 mrhx software  Русский перевод OpenGL  Русский перевод Win32 API
 
Используются технологии uCoz