please dont rip this site Prev Next

GetPrivateProfileStruct info  Overview  Group

The GetPrivateProfileStruct function retrieves the data associated with the specified key in the given section of an initialization file. As it retrieves the data, the function calculates a checksum and compares it with the checksum calculated by the WritePrivateProfileStruct function when the data was added to the file.

Win32-based applications should store initialization information in the registry.

BOOL GetPrivateProfileStruct(

    LPCTSTR lpszSection,

// address of section name

    LPCTSTR lpszKey,

// address of key name

    LPVOID lpStruct,

// address of return buffer

    UINT uSizeStruct,

// size of return buffer

    LPCTSTR szFile

// address of initialization filename

   );

Parameters

lpszSection
Points to a null-terminated string containing the section name in the initialization file.
lpszKey
Points to the null-terminated string containing the key name whose data is to be retrieved.
lpStruct
Points to the buffer that receives the data associated with the file, section, and key names.
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 does not contain a full path to the file, Windows searches for the file in the Windows directory.

Return Values

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero.

Remarks

A section in the initialization file must have the following form:

[section]
key=data
      .
      .
      .

Calls to private profile functions might be mapped to the registry instead of to the specified initialization files. This mapping is likely if an application modifies system-component initialization files, such as CONTROL.INI, SYSTEM.INI, and WINFILE.INI. In these cases, the GetPrivateProfileStruct function retrieves information from the registry, not from 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:

  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

WritePrivateProfileStruct 

See also:


file: /Techref/os/win/api/win32/func/src/f37_3.htm, 6KB, , updated: 2000/4/7 12:19, local time: 2022/5/24 00:03,
TOP NEW HELP FIND: 
18.205.176.39: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/f37_3.htm"> GetPrivateProfileStruct</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 @20220524
* 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!

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

  .