WritePrivateProfileStruct
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 |
|
); |
|
Parameters
lpszSection
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.
lpszKey
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 keys and entries
within the section, is deleted.
lpStruct
Points to a
buffer that contains the data to copy. If this parameter is NULL, the given key
is deleted.
uSizeStruct
Specifies the
size, in bytes, of the buffer pointed to by the lpStruct parameter.
szFile
Points to a
null-terminated string that names the initialization file. If this parameter is
NULL, the given information is copied into the WIN.INI 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
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:
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 "<No Name>") 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 "<No Name>") 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