SetupGetLineTextW 函数（setupapi.h）

项目
11/20/2024

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

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

语法

WINSETUPAPI BOOL SetupGetLineTextW(
  [in]      PINFCONTEXT Context,
  [in]      HINF        InfHandle,
  [in]      PCWSTR      Section,
  [in]      PCWSTR      Key,
  [in, out] PWSTR       ReturnBuffer,
  [in]      DWORD       ReturnBufferSize,
  [in, out] PDWORD      RequiredSize
);

参数

[in] Context

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

[in] InfHandle

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

[in] Section

指向 null-terminated 字符串的指针，该字符串指定要检索其文本的行的键名称的节。此参数可以 NULL。仅当 上下文NULL时，才使用此参数。如果 上下文NULL，则必须指定 InfHandle、节和键。

[in] Key

指向 null-terminated 字符串的指针，该字符串包含要检索其关联字符串的键名称。此参数可以 NULL。仅当 上下文NULL时，才使用此参数。如果 上下文NULL，则必须指定 InfHandle、节和键。

[in, out] ReturnBuffer

如果未 NULL，ReturnBuffer 指向此函数返回行内容的缓冲区。 null-terminated 字符串不能超过目标缓冲区的大小。可以调用函数一次以获取所需的缓冲区大小、分配必要的内存，然后再次调用该函数以检索数据。使用此技术，可以避免由于缓冲区大小不足而导致的错误。请参阅“备注”部分。此参数可以 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 [仅限桌面应用]
目标平台	窗户
标头	setupapi.h
库	Setupapi.lib
DLL	Setupapi.dll
API 集	ext-ms-win-setupapi-inf-l1-1-0（在 Windows 8 中引入）