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 | Скачать

WritePrivateProfileString

The WritePrivateProfileString function copies a string into the specified section of the specified initialization file.

This function is provided for compatibility with 16-bit Windows-based applications. WIn32-based applications should store initialization information in the registry.

BOOL WritePrivateProfileString(

LPCTSTR lpAppName, // pointer to section name
LPCTSTR lpKeyName, // pointer to key name
LPCTSTR lpString, // pointer to string to add
LPCTSTR lpFileName // pointer to initialization filename
);

Parameters

lpAppName

Points to a null-terminated string containing the name of the section to which the string will be copied. If the section does not exist, it is created. The name of the section is case-independent; the string can be any combination of uppercase and lowercase letters.

lpKeyName

Points to the null-terminated string containing the name of the key to be associated with a string. If the key does not exist in the specified section, it is created. If this parameter is NULL, the entire section, including all entries within the section, is deleted.

lpString

Points to a null-terminated string to be written to the file. If this parameter is NULL, the key pointed to by the lpKeyName parameter is deleted.
Windows 95: This platform does not support the use of the TAB (\t) character as part of this parameter.

lpFileName

Points to a null-terminated string that names the initialization file.

Return Values

If the function successfully copies the string to the initialization file, the return value is nonzero.
If the function fails, or if it flushes the cached version of the most recently accessed initialization file, the return value is zero. To get extended error information, call GetLastError.

Remarks

Windows 95:

Windows 95 keeps a cached version of WIN.INI to improve performance. If all three parameters are NULL, the function flushes the cache. The function always returns FALSE after flushing the cache, regardless of whether the flush succeeds or fails.

A section in the initialization file must have the following form:

[section]
key=string
.
.
.

If the lpFileName parameter does not contain a full path and filename for the file, WritePrivateProfileString searches the Windows directory for the file. If the file does not exist, this function creates the file in the Windows directory.
If lpFileName contains a full path and filename and the file does not exist, WriteProfileString creates the file. The specified directory must already exist.

Windows NT:

Windows NT maps most .INI file references to the registry, using the mapping defined under the following registry key:

HKEY_LOCAL_MACHINE\Software\Microsoft\
Windows NT\CurrentVersion\IniFileMapping
Windows NT keeps a cache for the IniFileMapping registry key. Calling WritePrivateProfileStringW with the value of all arguments set to NULL will cause Windows NT to refresh its cache of the IniFileMappingKey for the specified .INI file.
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.

An application using the WritePrivateProfileStringW function to enter .INI file information into the registry should follow these guidelines:

· Ensure that no .INI file of the specified name exists on the system.
· Ensure that there is a key entry in the registry that specifies the .INI file. This entry should be under the path HKEY_LOCAL_MACHINE\SOFTWARE \Microsoft\Windows NT\CurrentVersion\IniFileMapping.
· Specify a value for that .INI file key entry that specifies a section. That is to say, an application must specify a section name, as it would appear within an .INI file or registry entry. Here is an example: [My Section].

· For system files, specify SYS for an added value.
· For application files, specify USR within the added value. Here is an example: "My Section: USR: App Name\Section". And, since USR indicates a mapping under HKEY_CURRENT_USER, the application should also create a key under HKEY_CURRENT_USER that specifies the application name listed in the added value. For the example just given, that would be "App Name".
· After following the preceding steps, an application setup program should call WritePrivateProfileStringW with the first three parameters set to NULL, and the fourth parameter set to the INI filename. For example:

WritePrivateProfileStringW( NULL, NULL, NULL, L"appname.ini" );

· Such a call causes the mapping of an .INI file to the registry to take effect before the next system reboot. The operating system re-reads the mapping information into shared memory. A user will not have to reboot their computer after installing an application in order to have future invocations of the application see the mapping of the .INI file to the registry.

The following sample code illustrates the preceding guidelines and is based on several assumptions:

· There is an application named "App Name."
· That application uses an .INI file named "appname.ini."
· There is a section in the .INI file that we want to look like this:

[Section1]
FirstKey = It all worked out okay.
SecondKey = By golly, it works.
ThirdKey = Another test.

· The user will not have to reboot the system in order to have future invocations of the application see the mapping of the .INI file to the registry.

Here is the sample code :

// include files
#include
#include

// a main function
main()

{
// local variables
CHAR inBuf[80];
HKEY hKey1, hKey2;
DWORD dwDisposition;
LONG lRetCode;

// try to create the .INI file key
lRetCode = RegCreateKeyEx ( HKEY_LOCAL_MACHINE,
"SOFTWARE\\Microsoft\\Windows NT
\\CurrentVersion\\IniFileMapping\\appname.ini",
0, NULL, REG_OPTION_NON_VOLATILE, KEY_WRITE,

NULL, &hKey1,
&dwDisposition);

// if we failed, note it, and leave
if (lRetCode != ERROR_SUCCESS){
printf ("Error in creating appname.ini key\n");
return (0) ;
}

// try to set a section value
lRetCode = RegSetValueEx ( hKey1,
"Section1",
0,
REG_SZ,
"USR:App Name\\Section1",

20);

// if we failed, note it, and leave
if (lRetCode != ERROR_SUCCESS) {
printf ( "Error in setting Section1 value\n");
return (0) ;
}

// try to create an App Name key
lRetCode = RegCreateKeyEx ( HKEY_CURRENT_USER,
"App Name",
0, NULL, REG_OPTION_NON_VOLATILE, KEY_WRITE,
NULL, &hKey2,
&dwDisposition);

// if we failed, note it, and leave
if (lRetCode != ERROR_SUCCESS) {
printf ("Error in creating App Name key\n");
return (0) ;
}

// force the operating system to re-read the mapping into shared memory
// so that future invocations of the application will see it
// without the user having to reboot the system
WritePrivateProfileStringW( NULL, NULL, NULL, L"appname.ini" );

// if we get this far, all has gone well
// let's write some added values

WritePrivateProfileString ("Section1", "FirstKey",
"It all worked out okay.", "appname.ini");
WritePrivateProfileString ("Section1", "SecondKey",
"By golly, it works.", "appname.ini");
WritePrivateProfileSection ("Section1", "ThirdKey = Another Test.",
"appname.ini");

// let's test our work
GetPrivateProfileString ("Section1", "FirstKey",
"Bogus Value: Get didn't work", inBuf, 80,

"appname.ini");
printf ("%s", inBuf);

// okay, we are outta here
return(0);

}

See Also

GetPrivateProfileString, WriteProfileString

Пригласи друзей и счет твоего мобильника всегда будет положительным!

Пригласи друзей и счет твоего мобильника всегда будет положительным!

WritePrivateProfileString

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

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

BOOL WritePrivateProfileString(

LPCTSTR lpAppName, // УКАЗАТЕЛЬ в имя секции LPCTSTR lpKeyName, // указатель в ключевой lpString имени LPCTSTR, // указателя, чтобы нанизываться, чтобы добавлять указатель LPCTSTR lpFileName // к инициализации filename
);

Параметры

lpAppName

Точки на недействительный расторгнутую строку, содержащие имя секции на которой строка будет скопирована. Если секция не существует, создано. Имя секции случай-независимое; строка может быть любой комбинацией верхнего регистра писем и верхнего регистра.

lpKeyName

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

lpString

Точки на недействительный расторгнутую строку, которые нужно записывать в файл. Если этот параметр НЕДЕЙСТВИТЕЛЕН, клавиша указывалась, чтобы параметром lpKeyName удален.
Windows 95: Эта платформа не поддерживает использование ТАБ. (\t) символа как часть этого параметра.

lpFileName

Точки на недействительный расторгнутую строку, которые называют файл инициализации.

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

Если функция успешно копирует строку в файл инициализации, обратная величина ненулевая.
Если функция терпит неудачу, или если она сбрасывает кеш версию совсем недавно доступного файла инициализации, обратная величина нулевая. Для того, чтобы расширять информацию ошибки, назовите GetLastError.

Замечания

Windows 95:

Windows 95 держит кеш версию WIN.INI, чтобы улучшать исполнение. Если все три параметра НЕДЕЙСТВИТЕЛЬНЫ, функция сбрасывает кеш. Функция всегда возвращает ЛОЖЬ после краски кеша, независимо от того, что краска получает или терпит неудачу.

Секция в файле инициализации должна иметь следующее формы:

[section] key=string
.
.
.

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

Windows NT:

Windows NT отображает файловые ссылки .INI на регистрацию, использовавшие распределение определял под следующей клавишей регистрации:

HKEY_LOCAL_MACHINE\Software\Microsoft\ Windows NT\CurrentVersion\IniFileMapping
Windows NT держит кеш для клавиши регистрации IniFileMapping. Вызывая WritePrivateProfileStringW с величиной всех аргументов установленных на НЕДЕЙСТВИТЕЛЬНУЮ волю (завещание) заставлять Windows NT, чтобы освежать свой кеш IniFileMappingKey для определенного файла .INI.
Профиль 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, и текст после того, как префикс будет относительно этой клавиши.

Приложение, использовавшее функцию WritePrivateProfileStringW, чтобы вводить файловую информацию .INI в регистрацию должно последовать за этими руководящими принципами:

Проверять, что никакой файл .INI определенного имени не существует в системе.
Гарантировать, что есть ключевой вход в регистрации, которая определяет файл .INI. Этот вход должен быть под путем HKEY_LOCAL_MACHINE\SOFTWARE \Microsoft\Windows NT\CurrentVersion\IniFileMapping.
Определять величину для этого файлового ключевого входа .INI, который определяет секцию. То есть, приложение должно определить имя секции, как это должно появляться в пределах .INI файлового или входа регистрации. Вот пример: [Моя Секция].

Для системных файлов, определять SYS для дополнительной величины.
Для прикладных файлов, определять USR в пределах дополнительной величины. Вот пример: "Моя Секция: USR: Прил. Name\Section". И, поскольку USR указывает распределение под HKEY_CURRENT_USER, приложение должно также создать клавишу под HKEY_CURRENT_USER, которое определяет прикладное имя указывался в дополнительной величине. Для примера только что данного, что быть "Именем Прил.".
После следующего предыдущих шагов, прикладная программа установки должна называть WritePrivateProfileStringW с первыми тремя параметрами установленными на НЕДЕЙСТВИТЕЛЬНЫЙ, и четвертый параметр был установлен на INI filename. Например:

WritePrivateProfileStringW( НЕДЕЙСТВИТЕЛЬНЫЙ, НЕДЕЙСТВИТЕЛЬНЫЙ, НЕДЕЙСТВИТЕЛЬНЫЙ, L"appname.ini" );

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

Следующий код образца иллюстрирует предыдущие руководящие принципы и основан на нескольких предположениях:

Есть приложение называло "Имя Прил.." , Что приложение использует файл .INI называл "appname.ini." Есть секция в файле .INI, который мы хотим выглядеть похожим на это:

[Section1]
FirstKey = ЭТО все разработанные окей.
SecondKey = golly, ЭТО работает.
ThirdKey = ДРУГОЙ тест.

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

Вот код образца :

// включите файлы #include #include

// a основная функциональная основа()

{
// локальные переменные CHAR inBuf[80];
HKEY hKey1, hKey2;
DWORD dwDisposition;
ДОЛГО (ДЛИНОЙ) lRetCode;

// попытка, чтобы создавать the.ФАЙЛОВАЯ клавиша INI
lRetCode = RegCreateKeyEx ( HKEY_LOCAL_MACHINE, "SOFTWARE\\Microsoft\\Windows NT \\CurrentVersion\\IniFileMapping\\appname.ini", 0, НЕДЕЙСТВИТЕЛЬНОЕ, REG_OPTION_NON_VOLATILE, KEY_WRITE,

НЕДЕЙСТВИТЕЛЬНЫЙ, &hKey1, &dwDisposition);

// если мы потерпели бы неудачу, отметьте это, и останьтесь если (lRetCode != ERROR_SUCCESS){ printf ("Ошибка на создании appname.ini key\n");
возвращать (0);
}

// попытка, чтобы устанавливать величину секции lRetCode = RegSetValueEx ( hKey1, "Section1",
0,
REG_SZ, "USR:Прил. Name\\Section1",

20);

// если мы потерпели бы неудачу, отметьте это, и останьтесь если (lRetCode != ERROR_SUCCESS) { printf ( "Ошибка в установке Section1 value\n");
возвращать (0);
}

// попытка, чтобы создавать клавишу Имени Прил. lRetCode = RegCreateKeyEx ( HKEY_CURRENT_USER, "Имя Прил.", 0, НЕДЕЙСТВИТЕЛЬНОЕ, REG_OPTION_NON_VOLATILE, KEY_WRITE, НЕДЕЙСТВИТЕЛЬНЫЙ, &hKey2, &dwDisposition);

// если мы потерпели бы неудачу, отметьте это, и останьтесь если (lRetCode != ERROR_SUCCESS) { printf ("Ошибка на создании Имени Прил. key\n");
возвращать (0);
}

// усилие операционная система, чтобы читать вновь распределение в коллективную память // чтобы будущие вызовы приложения увидели это // без пользователя, имеющего, чтобы перезагружать систему WritePrivateProfileStringW( НЕДЕЙСТВИТЕЛЬНАЯ, НЕДЕЙСТВИТЕЛЬНАЯ, НЕДЕЙСТВИТЕЛЬНАЯ, L"appname.ini" );

// если мы получаем это значительно, все пошли хорошо // позволяйте записывать некоторые добавившие величины

WritePrivateProfileString ("Section1", "FirstKey", "ЭТО все разработанные окей.", "appname.ini");
WritePrivateProfileString ("Section1", "SecondKey", " golly, ЭТО работает.", "appname.ini");
WritePrivateProfileSection ("Section1", "ThirdKey = ДРУГОЙ Тест.", "appname.ini");

// давайте протестируем нашу работу GetPrivateProfileString ("Section1", "FirstKey", "Поддельная Величина: не Получите прокладывали", inBuf, 80,

"appname.ini");
printf ("%s", inBuf);

// окей, мы - outta здесь возвращать(0);

}

Смотри Также

GetPrivateProfileString, WriteProfileString

Используются технологии uCoz