调用 SetupWriteTextLogInfLine

应用程序可以调用 SetupWriteTextLogInfLine ,以在 SetupAPI 文本日志 中写入包含指定 INF 文件行文本的日志条目。

若要调用 SetupWriteTextLogInfLine,应用程序提供以下信息:

  • 通过调用 SetupGetThreadLogToken 获得的文本日志中某个节的日志令牌,或系统定义的日志令牌之一。 如果日志令牌与文本日志部分相关联,则 SetupWriteTextLogInfLine 将写入该节中的日志条目。 否则, SetupWriteTextLogInfLine 会将日志条目添加到文本日志部分不包含的日志部分。

    此外,SetupWriteTextLogInfLine 是否写入日志条目,以及 SetupWriteTextLogInfLine 将条目写入哪个文本日志,取决于系统定义的日志令牌值。

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

  • 一个标志值,由系统定义常量按位 OR 组合而成,用于指定事件级别、缩进深度以及是否包含时间戳。 事件级别在 设置文本日志的事件级别 中进行了说明。

    如果为文本日志设置的事件级别大于或等于条目的事件级别, SetupWriteTextLogInfLine 将在文本日志中写入日志条目。 否则, SetupWriteTextLogInfLine 不会在文本日志中写入日志条目。 通过使用缩进,可以排列格式化消息,使节中的信息更易于阅读和理解。

    有关详细信息,请参阅 写入缩进日志条目。

  • 包含该 INF 文件行的 INF 文件句柄。

  • INF 文件行的上下文。

SetupWriteTextLogInfLine 采用以下格式写入日志条目:

entry_prefix time_stampinf:indentation inf-line-text(inf-file-namelineline-number)

Where:

  • entry_prefix、time-stamp 和 indentation 字段与文本日志部分正文的格式中所述的字段相同。

  • inf: 字段指定TXTLOG_INF事件类别。 事件类别在启用文本日志的事件类别中进行了说明。

  • inf-line-text 字段包含指定 INF 文件行的文本。

  • inf-file-name 字段包含包含指定 INF 文件行的 INF 文件的名称。

  • 行字段指示后面的内容是 INF 文件中的行号。

  • 行号字段包含 INF 文件中指定行的行号。

以下示例演示应用程序通常如何在文本日志中记录 INF 行的文本。 此示例中的 INF 行是 INF AddReg 行。 应用程序调用 SetupWriteTextLogInfLine,并提供以下输入参数值:

  • LogToken 设置为 SetupGetThreadLogToken 返回的日志令牌或系统定义的 日志令牌。

  • LogFlags 设置为TXTLOG_DETAILS。 此示例不包括时间戳或更改缩进深度。 在此示例中,缩进深度为五个等宽字体空格。

  • InfHandle 设置为 INF 文件 hidserv.inf 的句柄。通过调用 Platform SDK 中记录的 SetupOpenInfFile 函数来获取此句柄。

  • 上下文被设置为包含文本“AddReg=HidServ_AddService_AddReg”的 INF 文件行的 INF 文件上下文。通过调用 Platform SDK 中记录的 SetupFindXxxLine 函数来获取该行的 INF 文件上下文。

LogToken 和 LogFlags 的值以与 SetupWriteTextLog 中所述相同的方式影响 SetupWriteTextLogInfLine 的操作。 此外, SetupWriteTextLogInfLine 使用事件目录TXTLOG_INF。

对于此示例,下面显示了 SetupWriteTextLogInfLine 将写入文本日志的日志条目的类型:

   inf:      AddReg=HidServ_AddService_AddReg  (hidserv.inf line 98)