SetupGetBinaryField 函数 (setupapi.h)
[此函数可用于“要求”部分所示的操作系统。 它可能在后续版本中变更或不可用。 不应再使用 SetupAPI 来安装应用程序。 请改用 Windows Installer 开发应用程序安装程序。 SetupAPI 继续用于安装设备驱动程序。]
SetupGetBinaryField 函数从 INF 文件节中的某一行检索二进制数据,从指定字段到行尾。
语法
WINSETUPAPI BOOL SetupGetBinaryField(
[in] PINFCONTEXT Context,
[in] DWORD FieldIndex,
[in, out] PBYTE ReturnBuffer,
[in] DWORD ReturnBufferSize,
[in, out] LPDWORD RequiredSize
);
参数
[in] Context
行的 INF 上下文。
[in] FieldIndex
指定行中应从中检索二进制数据的起始字段的从 1 开始的索引。 二进制数据是从每个字段生成的,从此点开始到行的末尾。 每个字段对应于 1 个字节,采用十六进制表示法。 对于此函数, 零的 FieldIndex 无效。
[in, out] ReturnBuffer
指向接收二进制数据的缓冲区的可选指针。 应确保目标缓冲区的大小或大于源缓冲区。 可以调用函数一次以获取所需的缓冲区大小,分配必要的内存,然后再次调用函数以检索数据。 使用此技术,可以避免由于缓冲区大小不足而导致的错误。 请参阅“备注”部分。
[in] ReturnBufferSize
ReturnBuffer 指向的缓冲区的大小(以字符为单位)。 此数字包括 null 终止符。
[in, out] RequiredSize
指向变量的可选指针,该变量接收指向 ReturnBuffer 的缓冲区的所需大小(以字符为单位)。 此数字包括 null 终止符。 如果所需的大小大于 ReturnBufferSize 指定的值,则函数将失败,对 GetLastError 的调用将返回ERROR_INSUFFICIENT_BUFFER。
返回值
如果函数成功,则返回值为非零值。
如果函数失败,则返回值为零。 要获得更多的错误信息,请调用 GetLastError。
如果 SetupGetBinaryField 检索的字段不是 0-FF 范围内的有效十六进制数字,GetLastError 将返回ERROR_INVALID_DATA。
注解
如果使用 NULL 的 ReturnBuffer 和零的 ReturnBufferSize 调用此函数,则该函数会将保存指定数据所需的缓冲区大小放入 RequiredSize 指向的变量中。 如果函数成功,则返回值为非零值。 否则,返回值为零,可以通过调用 GetLastError 获取扩展错误信息。
若要更好地了解此函数的工作原理,请考虑 INF 文件中的以下行。
X=34,FF,00,13
如果在上一行调用 了 SetupGetBinaryField ,则将二进制值 34、FF、00 和 13 放入 ReturnBuffer 指定的缓冲区中。
对于此函数的 Unicode 版本,缓冲区大小 ReturnBufferSize 和 RequiredSize 以字符数指定。 此数字包括 null 终止符。 对于此函数的 ANSI 版本,大小以字节数指定。
如果使用 NULL 的 ReturnBuffer 和零的 ReturnBufferSize 调用此函数,则该函数会将保存指定数据所需的缓冲区大小放入 RequiredSize 指向的变量中。 如果函数成功,则返回值为非零值。 否则,返回值为零,可以通过调用 GetLastError 获取扩展错误信息。
因此,可以调用函数一次以获取所需的缓冲区大小,分配必要的内存,然后再次调用函数以检索数据。 使用此技术,可以避免由于缓冲区大小不足而导致的错误。
要求
最低受支持的客户端 | Windows XP [仅限桌面应用] |
最低受支持的服务器 | Windows Server 2003 [仅限桌面应用] |
目标平台 | Windows |
标头 | setupapi.h |
Library | Setupapi.lib |
DLL | Setupapi.dll |