SetupGetMultiSzFieldA 函数 (setupapi.h)

  • 项目

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

SetupGetMultiSzField 函数检索存储在 INF 文件的一行中的多个字符串，从指定字段到行尾。

语法

WINSETUPAPI BOOL SetupGetMultiSzFieldA(
  [in]      PINFCONTEXT Context,
  [in]      DWORD       FieldIndex,
  [in, out] PSTR        ReturnBuffer,
  [in]      DWORD       ReturnBufferSize,
  [in]      LPDWORD     RequiredSize
);

参数

[in] Context

指向 INF 文件中行的上下文的指针。

[in] FieldIndex

指定行中应从中检索字符串的起始字段的从 1 开始的索引。 字符串列表是从此点开始到行尾的每个字段生成的。 对于此函数， 零的 FieldIndex 无效。

[in, out] ReturnBuffer

指向接收字符串的字符缓冲区的可选指针。 每个字符串以 null 结尾，字符串列表末尾有一个额外的 null 。 以 null 结尾的字符串不应超过目标缓冲区的大小。 可以调用函数一次以获取所需的缓冲区大小，分配必要的内存，然后再次调用函数以检索数据。 使用此技术，可以避免由于缓冲区大小不足而导致的错误。 请参阅“备注”部分。 此参数可以为 NULL。

[in] ReturnBufferSize

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

[in] RequiredSize

指向变量的可选指针，该变量接收 ReturnBuffer 指向的缓冲区所需的大小（以字符为单位）。 这包括 null 终止符。 如果所需的大小大于 ReturnBufferSize 指定的值，则函数将失败，对 GetLastError 的调用将返回ERROR_INSUFFICIENT_BUFFER。

返回值

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

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

注解

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

不应使用 SetupGetMultiSzField 来循环访问 INF 行上的字符串值。 应改用 SetupGetStringField。 SetupGetMultiSzField 返回REG_MULTI_SZ格式的值。 这是一个以 null 结尾的字符串数组，这些字符串由额外的 null 字符终止。 此格式不允许长度为零的字符串。 如果字符串列表包含任何长度为零的字符串， 则 SetupGetMultiSzField 在遇到第一个空白字符串值时会提前返回。

注意

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

要求

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

请参阅

函数

概述

SetupGetBinaryField

SetupGetIntField

SetupGetStringField