SetupWriteTextLogError-Funktion (setupapi.h)

Die SetupWriteTextLogError-Funktion schreibt Informationen zu einem SetupAPI-spezifischen Fehler oder einem Win32-Systemfehler in ein SetupAPI-Textprotokoll.

Syntax

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

Parameter

[in] LogToken

Ein Protokolltoken , das entweder ein systemdefiniertes Protokolltoken ist oder von SetupGetThreadLogToken zurückgegeben wurde.

[in] Category

Ein Wert vom Typ DWORD, der die Ereigniskategorie für den Protokolleintrag angibt. Die Ereigniskategorien, die für einen Protokolleintrag angegeben werden können, sind identisch mit denen, die für ein Textprotokoll aktiviert werden können. Eine Liste der Ereigniskategorien finden Sie unter Aktivieren von Ereigniskategorien für ein SetupAPI-Textprotokoll.

[in] LogFlags

Ein Wert vom Typ DWORD, der ein bitweises OR von Flagwerten ist, die Folgendes angeben:

• Die Ereignisebene für den Protokolleintrag. Die Ereignisebenen, die für einen Protokolleintrag angegeben werden können, sind identisch mit denen, die für ein Textprotokoll aktiviert werden können. Eine Liste der Flags auf Ereignisebene finden Sie unter Festlegen der Ereignisebene für ein Textprotokoll.
• Gibt an, ob ein Zeitstempel in den Protokolleintrag eingeschlossen werden soll. Der Zeitstempelflagwert ist TXTLOG_TIMESTAMP.
• Die Änderung, falls vorhanden, an der Einzugstiefe des Abschnitts und des aktuellen Protokolleintrags. Informationen zur Verwendung der Einzugsflags finden Sie unter Schreiben von Protokolleinträgen mit Einzug.

[in] Error

Ein SetupAPI-spezifischer Fehlercode oder ein Win32-Fehlercode. Die SetupAPI-spezifischen Fehlercodes sind in Setupapi.h aufgeführt. Die Win32-Fehlercodes sind in Winerror.h aufgeführt.

[in] MessageStr

Ein Zeiger auf eine NULL-beendete konstante Zeichenfolge, die eine printf-kompatible Formatzeichenfolge enthält, die die formatierte Nachricht angibt, die in den Protokolleintrag aufgenommen werden soll.

...

Eine durch Trennzeichen getrennte Parameterliste, die mit den Formatbezeichnern in der von MessageStr bereitgestellten Formatzeichenfolge übereinstimmt.

Rückgabewert

Keine

Bemerkungen

Wenn eine Installationsanwendung über einen SetupAPI-spezifischen Fehlercode oder einen Win32-Fehlercode verfügt, der einem Installationsfehler zugeordnet ist, kann die Anwendung SetupWriteTextLogError anstelle von SetupWriteTextLog aufrufen, um zwei Einträge in ein Textprotokoll zu schreiben. Der erste Eintrag entspricht dem von SetupWriteTextLog geschriebenen Eintrag, und der zweite Eintrag protokolliert den Fehlercode und eine benutzerfreundliche Beschreibung des Fehlers.

Protokolltoken, Ereigniskategorie und Flags, die von einem Aufrufer bereitgestellt werden, wirken sich auf den Vorgang von SetupWriteTextLogError auf die gleiche Weise wie für SetupWriteTextLog beschrieben aus.

SetupWriteTextLogError schreibt den ersten Protokolleintrag im folgenden Format:

Eintragspräfixtime_stampKategorieeinzugformatierte Nachricht

SetupWriteTextLogError schreibt den zweiten Protokolleintrag im folgenden Format:

Eintragspräfixtime_stampKategorieeinzugsfehler:error-numbererror-description

Hierbei gilt:

• Die Felder Eintragspräfix, Zeitstempel, Kategorie, Einzug und formatierte Nachricht sind identisch mit denen, die unter Format eines Textprotokollabschnittstexts beschrieben werden.
• Das Feld error-number enthält die Fehlernummer.
• Das Feld error-description enthält eine benutzerfreundliche Beschreibung des Fehlers.

Allgemeine Informationen zum Schreiben von Protokolleinträgen in den SetupAPI-Textprotokollen finden Sie unter SetupAPI-Protokollierung (Windows Vista).

Weitere Informationen zum Vorgang von SetupWriteTextLogError finden Sie unter Aufrufen von SetupWriteTextLogError.

Weitere Informationen zu Protokolltoken finden Sie unter Protokolltoken.

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

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Verfügbar in Windows Vista und späteren Windows-Versionen.
Zielplattform	Desktop
Kopfzeile	setupapi.h (schließen Sie Setupapi.h ein)
Bibliothek	Setupapi.lib

Weitere Informationen

SetupGetThreadLogToken

SetupWriteTextLog