Aufruf von SetupWriteTextLogInfLine

Eine Anwendung kann SetupWriteTextLogInfLine aufrufen, um einen Protokolleintrag in einem SetupAPI-Textprotokoll zu schreiben, das den Text einer angegebenen INF-Dateizeile enthält.

Beim Aufrufen von SetupWriteTextLogInfLine stellt eine Anwendung die folgenden Informationen bereit:

• Das Protokolltoken für einen Abschnitt in einem Textprotokoll, das durch Aufrufen von SetupGetThreadLogToken oder als eines der vom System definierten Protokolltoken abgerufen wurde. Wenn das Protokolltoken einem Textprotokollabschnitt zugeordnet ist, schreibt SetupWriteTextLogInfLine den Protokolleintrag in diesen Abschnitt. Andernfalls fügt SetupWriteTextLogInfLine den Protokolleintrag zu einem Teil des Protokolls hinzu, der nicht in einem Textprotokollabschnitt enthalten ist.

  Darüber hinaus hängt es vom systemdefinierten Protokolltokenwert ab, ob SetupWriteTextLogInfLine einen Protokolleintrag schreibt und in welches Textprotokoll SetupWriteTextLogInfLine den Eintrag schreibt.

  Weitere Informationen zu Protokolltoken finden Sie unter Festlegen und Abrufen eines Protokolltokens für einen Thread.

• Ein Flagwert, der ein bitweises ODER systemdefinierter Konstanten ist, die die Ereignisebene, die Einzugstiefe und die Frage angeben, ob ein Zeitstempel eingeschlossen werden soll. Ereignisebenen werden unter Festlegen der Ereignisebene für ein Textprotokoll beschrieben.

  Wenn die für das Textprotokoll festgelegte Ereignisebene größer oder gleich der Ereignisebene für den Eintrag ist, schreibt SetupWriteTextLogInfLine einen Protokolleintrag im Textprotokoll. Andernfalls schreibt SetupWriteTextLogInfLine keinen Protokolleintrag in das Textprotokoll. Mithilfe des Einzugs können formatierte Nachrichten angeordnet werden, damit die Informationen in einem Abschnitt leichter zu lesen und zu verstehen sind.

  Weitere Informationen finden Sie unter Schreiben von eingezogenen Protokolleinträgen.

• Ein Handle für die INF-Datei, die die Zeile in der INF-Datei enthält.

• Der Kontext für die INF-Dateizeile.

SetupWriteTextLogInfLine schreibt einen Protokolleintrag im folgenden Format:

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

Ort:

• Die Felder entry_prefix, Zeitstempel und Einzug sind mit denen identisch, die im Format eines Textprotokollabschnittstexts beschrieben werden.

• Das Feld inf: gibt die Ereigniskategorie TXTLOG_INF an. Ereigniskategorien werden unter Aktivieren von Ereigniskategorien für ein Textprotokoll beschrieben.

• Das inf-line-text-Feld enthält den Text der angegebenen INF-Dateizeile.

• Das Feld inf-file-name enthält den Namen der INF-Datei, die die angegebene INF-Dateizeile enthält.

• Das Zeilenfeld gibt an, dass es sich bei dem Folgenden um eine Zeilennummer in der INF-Datei handelt.

• Das Zeilennummerfeld enthält die Zeilennummer der angegebenen Zeile in der INF-Datei.

Das folgende Beispiel zeigt, wie eine Anwendung den Text einer INF-Zeile in einem Textprotokoll normalerweise protokollieren kann. Die INF-Zeile in diesem Beispiel ist eine INF-AddReg-Zeile. Die Anwendung ruft SetupWriteTextLogInfLine auf, wobei die folgenden Eingabeparameterwerte bereitgestellt werden:

• LogToken wird auf ein Protokolltoken festgelegt, das von SetupGetThreadLogToken zurückgegeben wurde, oder auf ein systemdefiniertes Protokolltoken.

• LogFlags ist auf TXTLOG_DETAILS festgelegt. Dieses Beispiel enthält keinen Zeitstempel und ändert die Einzugstiefe nicht. Im Beispiel beträgt die Einzugstiefe fünf Leerzeichen in einer nichtproportionalen Schriftart.

• InfHandle ist auf ein Handle für die INF-Datei hidserv.inf festgelegt. Dieses Handle wird durch Aufrufen der SetupOpenInfFile-Funktion abgerufen, die im Platform SDK dokumentiert ist.

• Kontext wird auf den INF-Dateikontext der INF-Dateizeile festgelegt, die den Text "AddReg=HidServ_AddService_AddReg" enthält. Ein INF-Dateikontext für die Zeile wird durch Aufrufen der SetupFindXxxLine-Funktionen abgerufen, die im Platform SDK dokumentiert sind.

Die Werte von LogToken und LogFlags beeinflussen die Funktionsweise von SetupWriteTextLogInfLine in derselben Weise, wie es für SetupWriteTextLog beschrieben ist. Darüber hinaus verwendet SetupWriteTextLogInfLine den Ereigniskatalog TXTLOG_INF.

In diesem Beispiel wird der Typ des Protokolleintrags gezeigt, den SetupWriteTextLogInfLine in ein Textprotokoll schreiben würde:

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