please dont rip this site Prev Next

WritePrivateProfileString info  Overview  Group

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 "<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.

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

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

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); 

 

} 

 

See Also

GetPrivateProfileString, WriteProfileString

See also:


file: /Techref/os/win/api/win32/func/src/f93_2.htm, 15KB, , updated: 2000/4/7 12:19, local time: 2022/5/20 10:44,
TOP NEW HELP FIND: 
3.239.129.91:LOG IN

 ©2022 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?
Please DO link to this page! Digg it! / MAKE!

<A HREF="http://www.piclist.com/techref/os/win/api/win32/func/src/f93_2.htm"> WritePrivateProfileString</A>

After you find an appropriate page, you are invited to your to this massmind site! (posts will be visible only to you before review) Just type a nice message (short messages are blocked as spam) in the box and press the Post button. (HTML welcomed, but not the <A tag: Instead, use the link box to link to another page. A tutorial is available Members can login to post directly, become page editors, and be credited for their posts.


Link? Put it here: 
if you want a response, please enter your email address: 
Attn spammers: All posts are reviewed before being made visible to anyone other than the poster.
Did you find what you needed?

  PICList 2022 contributors:
o List host: MIT, Site host massmind.org, Top posters @20220520
* Page Editors: James Newton, David Cary, and YOU!
* Roman Black of Black Robotics donates from sales of Linistep stepper controller kits.
* Ashley Roll of Digital Nemesis donates from sales of RCL-1 RS232 to TTL converters.
* Monthly Subscribers: Gregg Rew. on-going support is MOST appreciated!
* Contributors: Richard Seriani, Sr.
 

Welcome to www.piclist.com!

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

  .