SetupGetLineTextA 函数 (setupapi.h)

项目
08/26/2023

[此函数可用于“要求”部分所示的操作系统。它可能在后续版本中变更或不可用。安装程序API 不应再用于安装应用程序。请改用 Windows 安装程序来开发应用程序安装程序。 SetupAPI 继续用于安装设备驱动程序。]

SetupGetLineText 函数以紧凑形式返回 INF 文件中行的内容。要检索的行可以通过从 SetupFindLineXXX 函数返回的 INFCONTEXT 结构指定，也可以通过显式传入所需行的 INF 句柄、节和键来指定。

语法

WINSETUPAPI BOOL SetupGetLineTextA(
  [in]      PINFCONTEXT Context,
  [in]      HINF        InfHandle,
  [in]      PCSTR       Section,
  [in]      PCSTR       Key,
  [in, out] PSTR        ReturnBuffer,
  [in]      DWORD       ReturnBufferSize,
  [in, out] PDWORD      RequiredSize
);

参数

[in] Context

要检索其文本的 INF 文件中行的上下文。此参数可以为 NULL。如果 Context 为 NULL，则必须指定 InfHandle、 Section 和 Key 。

[in] InfHandle

要查询的 INF 文件的句柄。此参数可以为 NULL。仅当 Context 为 NULL 时，才使用此参数。如果 Context 为 NULL，则必须指定 InfHandle、 Section 和 Key 。

[in] Section

指向 以 null 结尾的字符串的指针，该字符串指定包含要检索其文本的行的键名称的节。此参数可以为 NULL。仅当 Context 为 NULL 时，才使用此参数。如果 Context 为 NULL，则必须指定 InfHandle、 Section 和 Key 。

[in] Key

指向以 null 结尾的字符串的指针，该字符串包含要检索其关联字符串的键名称。此参数可以为 NULL。仅当 Context 为 NULL 时，才使用此参数。如果 Context 为 NULL，则必须指定 InfHandle、 Section 和 Key 。

[in, out] ReturnBuffer

如果不是 NULL， 则 ReturnBuffer 指向此函数在其中返回行内容的缓冲区。 以 null 结尾的字符串不能超过目标缓冲区的大小。可以调用函数一次以获取所需的缓冲区大小，分配必要的内存，然后再次调用函数来检索数据。使用此方法可以避免由于缓冲区大小不足而导致的错误。请参阅“备注”部分。此参数可以为 NULL。

[in] ReturnBufferSize

ReturnBuffer 参数指向的缓冲区的大小（以字符为单位）。这包括 null 终止符。

[in, out] RequiredSize

如果不是 NULL，则指向一个变量，在此变量中，此函数返回 ReturnBuffer 参数指向的缓冲区所需的大小（以字符为单位）。这包括 null 终止符。如果指定 了 ReturnBuffer ，并且所需的大小大于 ReturnBufferSize 参数中指定的值，则函数将失败，并且不会将数据存储在缓冲区中。

返回值

如果函数成功，则返回值为非零值。

如果函数失败，则返回值为零。要获得更多的错误信息，请调用 GetLastError。

注解

如果使用 NULL 的 ReturnBuffer 和零的 ReturnBufferSize 调用此函数，则该函数会将保存指定数据所需的缓冲区大小放入 RequiredSize 指向的变量中。如果函数成功执行此操作，则返回值为非零值。否则，返回值为零，可以通过调用 GetLastError 获取扩展错误信息。

此函数以紧凑格式返回行的内容。删除所有无关空格，并将多行值转换为单个连续字符串。例如，以下行：

HKLM, , PointerClass0, 1 \
; This is a comment
01, 02, 03

将返回为：

HKLM,,PointerClass0,1,01,02,03

注意

setupapi.h 标头将 SetupGetLineText 定义为别名，该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 ANSI 或 Unicode 版本。将非特定编码别名的使用与非非特定编码的代码混合使用可能会导致不匹配，从而导致编译或运行时错误。有关详细信息，请参阅函数原型的约定。

要求

要求	值
最低受支持的客户端	Windows XP [仅限桌面应用]
最低受支持的服务器	Windows Server 2003 [仅限桌面应用]
目标平台	Windows
标头	setupapi.h
Library	Setupapi.lib
DLL	Setupapi.dll
API 集	在 Windows 8) 中引入的 ext-ms-win-setupapi-inf-l1-1-0 (