GetPrivateProfileStructA 函数 (winbase.h)
检索与初始化文件的指定节中的键关联的数据。 在检索数据时,函数会计算校验和,并将其与将数据添加到文件时 由 WritePrivateProfileStruct 函数计算的校验和进行比较。
语法
BOOL GetPrivateProfileStructA(
[in] LPCSTR lpszSection,
[in] LPCSTR lpszKey,
[out] LPVOID lpStruct,
[in] UINT uSizeStruct,
[in] LPCSTR szFile
);
参数
[in] lpszSection
初始化文件中节的名称。
[in] lpszKey
要检索其数据的键的名称。
[out] lpStruct
指向缓冲区的指针,该缓冲区接收与文件、节和键名称关联的数据。
[in] uSizeStruct
lpStruct 参数指向的缓冲区大小(以字节为单位)。
[in] szFile
初始化文件的名称。 如果此参数不包含文件的完整路径,系统会在 Windows 目录中搜索该文件。
返回值
如果该函数成功,则返回值为非零值。
如果函数失败,则返回值为零。
注解
初始化文件中的节必须具有以下形式:
[section]
key=data
.
.
.
系统使用以下注册表项下定义的映射将大多数 .ini 文件引用映射到注册表:HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\IniFileMapping
如果应用程序修改 Control.ini、System.ini 和 Winfile.ini 等系统组件初始化文件,则此映射很可能。 在这些情况下,函数从注册表检索信息,而不是从初始化文件中检索信息;存储位置中的更改不会影响函数的行为。
配置文件函数使用以下步骤来查找初始化信息:
- 在注册表中查找初始化文件的名称,例如 IniFileMapping 下的 MyFile.ini。
- 查找 lpAppName 指定的节名称。 这将是 myfile.ini下的命名值,或者 myfile.ini的子项,或者不存在。
- 如果 lpAppName 指定的节名称是 myfile.ini下的命名值,则该值指定在注册表中查找节键的位置。
- 如果 lpAppName 指定的节名称是 myfile.ini的子项,则该子项下的命名值将指定在注册表中的位置,以便找到该节的键。 如果要查找的项不存在为命名值,则 (未命名的值显示为 <“无名称>) ”,指定在注册表中查找密钥的默认位置。
- 如果 lpAppName 指定的节名称不存在为命名值或 myfile.ini下的子项,则在myfile.ini下,将有一个未命名值 (显示为 <“无名称>) ”,该名称指定注册表中的默认位置,可在其中找到分区的键。
- 如果没有 myfile.ini 子项,或者它不包含节名称的条目,请在磁盘上查找实际 MyFile.ini 并读取其内容。
- ! - 此字符强制所有写入操作同时转到注册表和磁盘上的 .ini 文件。
- # - 当新用户在安装后首次登录时,此字符会导致注册表值设置为 Windows 3.1 .ini 文件中的值。
- @ - 如果注册表中找不到请求的数据,此字符将阻止任何读取操作转到磁盘上的 .ini 文件。
- USR: - 此前缀代表 HKEY_CURRENT_USER,前缀后面的文本相对于该键。
- SYS: - 此前缀代表 HKEY_LOCAL_MACHINE\SOFTWARE,前缀后面的文本相对于该键。
注意
winbase.h 标头将 GetPrivateProfileStruct 定义为别名,该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 ANSI 或 Unicode 版本。 将非特定编码别名的使用与非非特定编码的代码混合使用可能会导致不匹配,从而导致编译或运行时错误。 有关详细信息,请参阅 函数原型的约定。
要求
要求 | 值 |
---|---|
最低受支持的客户端 | Windows 2000 Professional [仅限桌面应用] |
最低受支持的服务器 | Windows 2000 Server [仅限桌面应用] |
目标平台 | Windows |
标头 | winbase.h (包括 Windows.h) |
Library | Kernel32.lib |
DLL | Kernel32.dll |