|
|
|
|
|
|
|
|
|
Quick Info
Windows NT
| Yes
| Win95
| Yes
| Win32s
| No
| Import Library
| kernel32.lib
| Header File
| winbase.h
| Unicode
| WinNT
| Platform Notes
| None
|
|
|
GetPrivateProfileStruct
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:
- 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
- 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.
- 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.
- 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.
- 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.
- 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
| Last news from Greatis Software |
 |
|
Nostalgia .Net |
|
.Net is powerful, but not all-powerful, so sometimes we need to use Win32 API for our .Net applications. It's simple enough with Platform Invoke if you have Win32 skill, but we do not always have time to dig the ancient documentation, declare the special types that are compatible with Win32, find the values of the Win32's constants and so on. Nostalgia .Net offers several simple-to-use classes, and components that will allow you to forget about the headache of Win32 and just use the power of Win32 in your application the same way as you use the native. Net classes. More » |
| Recommended software for developers |
 |
|
Ultimate Pack |
|
Component pack for Delphi and C++ Builder that contains runtime form designer, runtime object inspector, print suite and much more for the very special price. More » |
 |
|
Form Designer .Net |
|
Unique runtime form design solution that allows to edit any form in .Net WinForms application at runtime with full source codes for only 300 euro! More » |
 |
|
Print Suite .Net |
|
Print Suite .Net is a set of components for easy printing texts, images and grids from your WinForms applications. Full C# source codes are available More » |
 |
|
Gradient Controls .Net |
|
Gradient Controls .Net offers controls with gradient background feature. Labels, panels and so on... Full C# source codes are available More » |
 |
|
Greatis iGrid |
|
iGrid plots drawing grid right over your desktop, so you can use it everywhere, with any drawing application without any special plugins for different graphic editors. More » |
All the contacts and projectsDmitry Vasiliev (just.dmitry)
Related LinksSoftware for Visual Studio .NET developers
Software for Delphi and C++ Builder developers
Software for Visual Basic 6 developers
Delphi Tips&Tricks
MegaDetailed.NET More Online Helps Win32 Programmer's Reference
Win32 Multimedia Programmer's Reference
OLE Programmer's Reference
Microsoft Windows Pen API Programmer's Reference
Microsoft Windows Sockets 2 Reference
Microsoft Windows Telephony API (TAPI) Programmer's Reference
Unix Manual Pages
|
