Platform SDK: Registry |
The WriteProfileSection function replaces the contents of the specified section in the Win.ini file with specified keys and values.
Note This function is provided only for compatibility with 16-bit versions of Windows. Win32-based applications should store initialization information in the registry.
BOOL WriteProfileSection( LPCTSTR lpAppName, // section name LPCTSTR lpString // data buffer );
If the function succeeds, the return value is nonzero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.
Windows 95: If there is no section in Win.ini that matches the specified section name, WriteProfileSection creates the section at the end of the file and initializes the new section with the key name and value pairs specified in the lpString parameter.
Keys and values in the lpString buffer consist of one or more null-terminated strings, followed by a final null character. Each string has the following form:
key=string
The WriteProfileSection function is not case-sensitive; the strings can be a combination of uppercase and lowercase letters.
WriteProfileSection deletes the existing keys and values for the named section and inserts the key names and values in the buffer pointed to by lpString. The function does not attempt to correlate old and new key names; if the new names appear in a different order from the old names, any comments associated with preexisting keys and values in the initialization file will probably be associated with incorrect keys and values.
This operation is atomic; no other operations that read from or write to the initialization file are allowed while the information is being written.
Windows NT/2000: The system 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
When the operation has been mapped, the WriteProfileSection function writes information to the registry, not to 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:
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:
Windows NT/2000: Requires Windows NT 3.1 or later.
Windows 95/98: Requires Windows 95 or later.
Header: Declared in Winbase.h; include Windows.h.
Library: Use Kernel32.lib.
Unicode: Implemented as Unicode and ANSI versions on Windows NT/2000.
Registry Overview, Registry Functions, GetProfileSection, WritePrivateProfileSection