setupQueryFileLogW 函数 (setupapi.h)

  • 项目

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

SetupQueryFileLog 函数从安装文件日志返回信息。

语法

WINSETUPAPI BOOL SetupQueryFileLogW(
  [in]      HSPFILELOG       FileLogHandle,
  [in]      PCWSTR           LogSectionName,
  [in]      PCWSTR           TargetFilename,
  [in]      SetupFileLogInfo DesiredInfo,
  [in, out] PWSTR            DataOut,
  [in]      DWORD            ReturnBufferSize,
  [in, out] PDWORD           RequiredSize
);

参数

[in] FileLogHandle

SetupInitializeFileLog 返回的文件日志的句柄。

[in] LogSectionName

指向日志文件节名称的可选指针，格式对调用方有意义。 应使用以 null 结尾的字符串。 非系统日志是必需的。 如果未为系统日志指定 LogSectionName ，则提供默认值。

[in] TargetFilename

需要其日志信息的文件的名称。 应使用以 null 结尾的字符串。

[in] DesiredInfo

指示应将哪些信息返回到 DataOut 缓冲区。 此参数可以是下列枚举值之一。

值 含义
SetupFileLogSourceFile 名称
 源文件在源媒体上存在的名称
SetupFileLogChecksum
 系统日志使用的校验和值
SetupFileLogDiskTagfile
 包含源文件的媒体源的标记文件的名称
SetupFileLogDiskDescription
 源文件所在媒体的可读说明
SetupFileLogOtherInfo
 与记录的文件关联的其他信息
 

如果 DesiredInfo 的值大于 SetupFileLogOtherInfo ，函数将失败， GetLastError 将返回ERROR_INVALID_PARAMETER。

[in, out] DataOut

指向缓冲区的可选指针，此函数在该缓冲区中返回文件的请求信息。 应使用以 null 结尾的字符串。 以 null 结尾的字符串不应超过目标缓冲区的大小。 可以调用函数一次以获取所需的缓冲区大小，分配必要的内存，然后再次调用函数以检索数据。 请参阅“备注”部分。 使用此技术，可以避免由于缓冲区大小不足而导致的错误。 并非每个文件都提供所有信息。 如果日志中存在文件的空条目，则不会返回错误。 此参数可以为 NULL。

[in] ReturnBufferSize

DataOut 缓冲区的大小（以字符为单位）。 这包括 null 终止符。 如果缓冲区太小并且指定 了 DataOut ，则数据不会存储在缓冲区中，并且函数返回零。 如果未指定 DataOut ，则忽略 ReturnBufferSize 参数。

[in, out] RequiredSize

指向接收 DataOut 所需大小的变量（以字符为单位）的可选指针。 此数字包括 null 终止符。

返回值

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

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

注解

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

如果 DesiredInfo 的值大于 SetupFileLogOtherInfo ，函数将失败， GetLastError 将返回ERROR_INVALID_PARAMETER。

注意

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

要求

要求 值
最低受支持的客户端 Windows XP [仅限桌面应用]
最低受支持的服务器 Windows Server 2003 [仅限桌面应用]
目标平台 Windows
标头 setupapi.h
Library Setupapi.lib
DLL Setupapi.dll

请参阅

函数

概述

SetupLogFile