GetPrivateProfileStructA 函数 (winbase.h)

检索与初始化文件指定节中的键关联的数据。 在检索数据时,该函数将计算校验和并将其与 WritePrivateProfileStruct 函数在将数据添加到文件时计算的校验和进行比较。

注意 此函数仅用于与基于 16 位 Windows 的应用程序兼容。 应用程序应在注册表中存储初始化信息。
 

语法

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),则此映射可能会发生这种情况。 在这些情况下,函数从注册表检索信息,而不是从初始化文件检索信息;存储位置的更改对函数的行为没有影响。

配置文件函数使用以下步骤查找初始化信息:

  1. IniFileMapping下查找初始化文件的名称(例如 MyFile.ini)。
  2. 查找由 lpAppName指定的节名称。 此值为 myfile.ini下的命名值,或 myfile.ini的子项,或者不存在。
  3. 如果由 lpAppName 指定的节名称是 myfile.ini下的命名值,则该值指定注册表中将找到该节的键的位置。
  4. 如果由 lpAppName 指定的节名称是 myfile.ini的子项,则在该子项下命名的值指定注册表中将找到分区的键的位置。 如果要查找的键不存在为命名值,则会有一个未命名的值(显示为“<无名称>”),用于指定注册表中可以找到该键的默认位置。
  5. 如果由 lpAppName 指定的节名称不存在为命名值或 myfile.ini下的子项,则在 myfile.ini 下,将有一个未命名的值(显示为“<无名称>”),用于指定注册表中的默认位置,可在其中找到分区的键。
  6. 如果没有 myfile.ini 子项,或者它不包含分区名称的条目,则查找磁盘上的实际 MyFile.ini 并读取其内容。
在注册表中查看指定其他注册表位置的值时,有几个前缀会更改 .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 [仅限桌面应用]
目标平台 窗户
标头 winbase.h (包括 Windows.h)
Kernel32.lib
DLL Kernel32.dll

另请参阅

WritePrivateProfileStruct