setupWriteTextLogError 函数 (setupapi.h)

SetupWriteTextLogError 函数将有关 SetupAPI 特定错误或 Win32 系统错误的信息写入 SetupAPI 文本日志

语法

WINSETUPAPI VOID SetupWriteTextLogError(
  [in] SP_LOG_TOKEN LogToken,
  [in] DWORD        Category,
  [in] DWORD        LogFlags,
  [in] DWORD        Error,
  [in] PCSTR        MessageStr,
       ...          
);

参数

[in] LogToken

作为系统定义的 日志令牌 或由 SetupGetThreadLogToken 返回的日志令牌。

[in] Category

类型为 DWORD 的值,指示日志条目的事件类别。 可为日志条目指定的事件类别与可为文本日志启用的事件类别相同。 有关事件类别的列表,请参阅 为 SetupAPI 文本日志启用事件类别

[in] LogFlags

类型为 DWORD 的值,该值是标志值的按位 OR,可指定以下内容:

  • 日志条目的事件级别。 可为日志条目指定的事件级别与可为文本日志启用的事件级别相同。 有关事件级别标志的列表,请参阅 设置文本日志的事件级别
  • 是否在日志条目中包含时间戳。 时间戳标志值TXTLOG_TIMESTAMP。
  • 更改部分和当前日志条目的缩进深度(如果有)。 有关如何使用缩进标志的信息,请参阅 编写缩进日志条目

[in] Error

特定于安装程序API 的错误代码或 Win32 错误代码。 Setupapi.h 中列出了特定于 SetupAPI 的错误代码。 Win32 错误代码列在 Winerror.h 中。

[in] MessageStr

指向以 NULL 结尾的常量字符串的指针,该字符串包含 与 printf 兼容的格式字符串,该字符串指定要包含在日志条目中的格式化消息。

...

一个逗号分隔的参数列表,它与 MessageStr 提供的格式字符串中的格式说明符相匹配。

返回值

备注

如果安装应用程序具有特定于 SetupAPI 的错误代码或与安装错误关联的 Win32 错误代码,则应用程序可以调用 SetupWriteTextLogError 而不是 SetupWriteTextLog ,以将两个条目写入文本日志。 第一个条目将与 SetupWriteTextLog 编写的条目相同,第二个条目将记录错误代码和错误的用户友好说明。

调用方提供的日志令牌、事件类别和标志影响 SetupWriteTextLogError 操作的方式与 SetupWriteTextLog 中所述的方式相同。

SetupWriteTextLogError 以以下格式写入第一个日志条目:

entry-prefixtime_stamp 类别缩进formatted-message

SetupWriteTextLogError 以以下格式写入第二个日志条目:

entry-prefixtime_stamp类别缩进错误:error-numbererror-description

其中:

  • 条目前缀时间戳类别缩进格式化消息字段与文本日志节正文的格式中所述的字段相同。
  • 错误号字段包含错误号。
  • 错误说明字段包含错误的用户友好说明。
有关在安装程序API 文本日志中写入日志条目的一般信息,请参阅 Windows Vista) (SetupAPI 日志记录

有关 SetupWriteTextLogError 操作的详细信息,请参阅 调用 SetupWriteTextLogError

有关日志令牌的详细信息,请参阅 日志令牌

有关使用日志令牌的详细信息,请参阅 设置和获取线程的日志令牌

要求

要求
最低受支持的客户端 在 Windows Vista 和更高版本的 Windows 中可用。
目标平台 桌面
标头 setupapi.h (包括 Setupapi.h)
Library Setupapi.lib

另请参阅

SetupGetThreadLogToken

SetupWriteTextLog