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-terminated 字符串。 非系统日志是必需的。 如果未为系统日志指定 LogSectionName,则提供默认值。

[in] TargetFilename

需要日志信息的文件的名称。 应使用 null-terminated 字符串。

[in] DesiredInfo

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

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

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

[in, out] DataOut

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

[in] ReturnBufferSize

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

[in, out] RequiredSize

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

返回值

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

如果函数失败,则返回值为零。 若要获取扩展的错误信息,请调用 GetLastError

言论

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

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

注意

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

要求

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

另请参阅

Functions

概述

SetupLogFile