Fonction SetupWriteTextLogError (setupapi.h)

Article
03/01/2024

La fonction SetupWriteTextLogError écrit des informations sur une erreur spécifique à SetupAPI ou une erreur système Win32 dans un journal texte SetupAPI.

Syntaxe

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

Paramètres

[in] LogToken

Jeton de journal qui est un jeton de journal défini par le système ou qui a été retourné par SetupGetThreadLogToken.

[in] Category

Valeur de type DWORD qui indique la catégorie d’événement pour l’entrée de journal. Les catégories d’événements qui peuvent être spécifiées pour une entrée de journal sont les mêmes que celles qui peuvent être activées pour un journal texte. Pour obtenir la liste des catégories d’événements, consultez Activation des catégories d’événements pour un programme d’installation Journal de texte API.

[in] LogFlags

Valeur de type DWORD au niveau du bit OR des valeurs d’indicateur, qui spécifient les éléments suivants :

Niveau d’événement pour l’entrée de journal. Les niveaux d’événements qui peuvent être spécifiés pour une entrée de journal sont les mêmes que ceux qui peuvent être activés pour un journal texte. Pour obtenir la liste des indicateurs de niveau d’événement, consultez Définition du niveau d’événement pour un journal de texte.
Indique s’il faut inclure un horodatage dans l’entrée de journal. La valeur de l’indicateur d’horodatage est TXTLOG_TIMESTAMP.
Modification, le cas échéant, de la profondeur de retrait de la section et de l’entrée de journal actuelle. Pour plus d’informations sur l’utilisation des indicateurs de retrait, consultez Écriture d’entrées de journal mises en retrait.

[in] Error

Un code d’erreur spécifique à SetupAPI ou un code d’erreur Win32. Les codes d’erreur spécifiques à SetupAPI sont répertoriés dans Setupapi.h. Les codes d’erreur Win32 sont répertoriés dans Winerror.h.

[in] MessageStr

Pointeur vers une chaîne constante terminée par null qui contient une chaîne de format compatible printf, qui spécifie le message mis en forme à inclure dans l’entrée de journal.

...

Liste de paramètres séparés par des virgules qui correspond aux spécificateurs de format dans la chaîne de format fournie par MessageStr.

Valeur de retour

None

Remarques

Si une application d’installation a un code d’erreur spécifique à SetupAPI ou un code d’erreur Win32 associé à une erreur d’installation, l’application peut appeler SetupWriteTextLogError au lieu de SetupWriteTextLog pour écrire deux entrées dans un journal de texte. La première entrée sera identique à celle écrite par SetupWriteTextLog et la deuxième entrée journalisera le code d’erreur et une description conviviale de l’erreur.

Le jeton de journal, la catégorie d’événement et les indicateurs qu’un appelant fournit affectent le fonctionnement de SetupWriteTextLogError sont identiques à ceux décrits pour SetupWriteTextLog.

SetupWriteTextLogError écrit la première entrée de journal au format suivant :

entry-prefixtime_stamp categoryindentationformatted-message

SetupWriteTextLogError écrit la deuxième entrée de journal au format suivant :

entry-prefixtime_stampcategoryindentationError :error-numbererror-description

Où :

Les champs entry-prefix, time-stamp, category, indentation et formatted-message sont les mêmes que ceux décrits dans Format of a Text Log Section Body.
Le champ error-number contient le numéro d’erreur.
Le champ error-description contient une description conviviale de l’erreur.

Pour obtenir des informations générales sur l’écriture d’entrées de journal dans les journaux de texte SetupAPI, consultez SetupApi Logging (Windows Vista).

Pour plus d’informations sur le fonctionnement de SetupWriteTextLogError, consultez Calling SetupWriteTextLogError.

Pour plus d’informations sur les jetons de journal, consultez Jetons de journal.

Pour plus d’informations sur l’utilisation des jetons de journal, consultez Définition et obtention d’un jeton de journal pour un thread.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Disponible dans Windows Vista et les versions plus récentes de Windows.
Plateforme cible	Desktop (Expérience utilisateur)
En-tête	setupapi.h (inclure Setupapi.h)
Bibliothèque	Setupapi.lib

Voir aussi

SetupGetThreadLogToken

SetupWriteTextLog

Partager via