SetupWriteTextLog 向 SetupAPI 文本日志添加一个条目,其中包含有关安装事件的信息。
如 文本日志节正文的格式中所述,日志条目的格式由以下字段组成:
entry_prefix time_stamp event_category indentation formatted_message
若要调用 SetupWriteTextLog,应用程序提供以下信息:
通过调用 SetupGetThreadLogToken 获取的文本日志中某个节的 日志令牌,或系统定义的日志令牌之一。 如果日志令牌与文本日志部分相关联,则 SetupWriteTextLog 将写入该部分中的日志条目。 否则, SetupWriteTextLog 会将日志条目添加到文本日志节中不包含的日志的一部分。 此外,SetupWriteTextLog 是否写入日志条目,以及 SetupWriteTextLog 将条目写入哪个文本日志,取决于系统定义的日志令牌值。
有关日志令牌的详细信息,请参阅 设置和获取线程的日志令牌。
为文本日志启用事件类别中描述的事件类别之一。 如果为文本日志启用了条目的事件类别, 则 SetupWriteTextLog 会将条目添加到文本日志;否则, SetupWriteTextLog 不会将条目写入文本日志。
一个标志值,由系统定义的常量按位 OR 组合而成,这些常量用于指定事件级别、缩进深度以及是否包含时间戳。 事件级别在设置文本日志的事件级别中进行了说明。 如果为文本日志设置的事件级别大于或等于该条目的事件级别,则 SetupWriteTextLog 会将日志条目写入文本日志;否则,SetupWriteTextLog 不会将日志条目写入文本日志。 通过使用缩进,可以排列带格式的消息,使节中的信息更易于阅读和理解。 有关详细信息,请参阅 写入缩进日志条目。
一个与 printf 兼容的格式字符串,用于格式化消息以及该格式字符串后面的逗号分隔变量列表。
以逗号分隔的变量列表,其值由 printf 兼容的格式字符串格式化。
有关如何调用 SetupWriteTextLog 以记录有关不是错误或警告的事件的信息的示例,请参阅 编写信息日志条目。
有关如何调用 SetupWriteTextLog 记录有关错误或警告的信息的示例,请参阅 编写错误或警告日志条目。