The WritePrivateProfileStruct function copies data into the specified key in the given section of an initialization file. As it copies the data, the function calculates a checksum and appends it to the end of the data. The GetPrivateProfileStruct function uses the checksum to ensure the integrity of the data. This function is provided for compatibility with 16-bit Windows-based applications. Win32-based applications should store initialization information in the registry.
BOOL WritePrivateProfileStruct(
LPCTSTR lpszSection, |
// pointer to section name |
LPCTSTR lpszKey, |
// pointer to key name |
LPVOID lpStruct, |
// pointer to buffer that contains data to add |
UINT uSizeStruct, |
// size, in bytes, of the buffer |
LPCTSTR szFile |
// pointer to initialization filename |
); |
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.
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 szFile 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 szFile contains a full path and filename and the file does not exist, WriteProfileString creates the file. The specified directory must already exist.
The Win32 Profile functions (Get/WriteProfile*, Get/WritePrivateProfile*) use the following steps to locate initialization information:
HKEY_LOCAL_MACHINE\Software\Microsoft\
Windows NT\CurrentVersion\IniFileMapping\myfile.ini
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.
GetPrivateProfileString, WriteProfileString
file: /Techref/os/win/api/win32/func/src/f93_3.htm, 7KB, , updated: 2000/4/7 11:19, local time: 2024/12/8 13:48,
18.97.9.169:LOG IN
|
©2024 These pages are served without commercial sponsorship. (No popup ads, etc...).Bandwidth abuse increases hosting cost forcing sponsorship or shutdown. This server aggressively defends against automated copying for any reason including offline viewing, duplication, etc... Please respect this requirement and DO NOT RIP THIS SITE. Questions? <A HREF="http://massmind.org/techref/os/win/api/win32/func/src/f93_3.htm"> WritePrivateProfileStruct</A> |
Did you find what you needed? |
Welcome to massmind.org! |
Welcome to massmind.org! |
.