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 |
); |
Windows 95: This platform does not support the use of the TAB (\t)
character as part of this parameter.
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.
[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.
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:
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.
An application using the WritePrivateProfileStringW function to enter .INI file information into the registry should follow these guidelines:
WritePrivateProfileStringW( NULL, NULL, NULL, L"appname.ini" );
The following sample code illustrates the preceding guidelines and is based on several assumptions:
[Section1] FirstKey = It all worked out okay. SecondKey = By golly, it works. ThirdKey = Another test.
Here is the sample code :
// include files #include <stdio.h> #include <windows.h> // 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); }
GetPrivateProfileString, WriteProfileString
file: /Techref/os/win/api/win32/func/src/f93_2.htm, 15KB, , updated: 2000/4/7 12:19, local time: 2024/8/16 10:06,
18.219.91.251: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://sxlist.com/TECHREF/os/win/api/win32/func/src/f93_2.htm"> WritePrivateProfileString</A> |
Did you find what you needed? |
Welcome to sxlist.com!sales, advertizing, & kind contributors just like you! Please don't rip/copy (here's why Copies of the site on CD are available at minimal cost. |
Welcome to sxlist.com! |
.