SetupWriteTextLog, fonction (setupapi.h)

Article
08/26/2023

La fonction SetupWriteTextLog écrit une entrée de journal dans un journal texte SetupAPI.

Syntaxe

WINSETUPAPI VOID SetupWriteTextLog(
  [in] SP_LOG_TOKEN LogToken,
  [in] DWORD        Category,
  [in] DWORD        Flags,
  [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] Flags

Valeur de type DWORD qui est un or au niveau du bit 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 programme d’installation Journal de texte API.
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] 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. La liste de paramètres séparés par des virgules qui suit MessageStr doit correspondre aux spécificateurs de format dans la chaîne de format.

...

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 la valeur de LogToken a été retournée par un appel à SetupGetThreadLogToken et que la section du journal texte correspondante est disponible, SetupWriteTextLog écrit l’entrée de journal dans cette section de journal de texte. Si SetupWriteTextLog ne parvient pas à localiser la section, SetupWriteTextLog écrit l’entrée de journal dans le journal texte correspondant, mais n’inclut pas l’entrée de journal dans une section.

Si la valeur de LogToken est l’un des jetons de journal définis par le système répertoriés dans le tableau suivant, SetupWriteTextLog effectue l’opération d’écriture indiquée pour ce jeton de journal.

Jeton de journal défini par le système	Opération d’écriture
LOGTOKEN_NOLOG	L’entrée de journal n’est écrite dans aucun journal texte.
LOG_TOKEN_UNSPECIFIED	L’entrée du journal est écrite dans le journal de texte d’installation de l’application. L’entrée de journal n’est pas incluse dans une section de journal texte.
LOGTOKEN_SETUPAPI_APPLOG	L’entrée du journal est écrite dans le journal de texte d’installation de l’application. L’entrée de journal n’est pas incluse dans une section de journal texte.
LOGTOKEN_SETUPAPI_DEVLOG	L’entrée du journal est écrite dans le journal de texte d’installation de l’appareil. L’entrée de journal n’est pas incluse dans une section de journal texte.

Note La définition de la valeur de LogToken sur l’un des jetons de journal définis par le système ne modifie pas la valeur du jeton de journal actuel pour le thread.

En outre, SetupWriteTextLog n’écrit pas d’entrée de journal lorsque l’une des conditions suivantes est remplie :

Le niveau d’événement défini pour le journal de texte est inférieur au niveau d’événement spécifié pour l’entrée de journal.
La catégorie d’événements de l’entrée de journal n’est pas activée pour le journal de texte. Pour plus d’informations sur les catégories d’événements, consultez Activation des catégories d’événements pour un journal de texte.

La longueur maximale, en caractères, d’une entrée de journal est de 336.

Pour écrire des informations sur une erreur spécifique à SetupAPI ou une erreur Win32 dans un journal de texte, une application peut utiliser SetupWriteTextLogError.

Pour obtenir des informations générales sur l’écriture d’entrées de journal dans les journaux de texte SetupAPI, consultez Setup LoggingAPI (Windows Vista et versions ultérieures).

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

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
Ensemble d’API	ext-ms-win-setupapi-logging-l1-1-0 (introduit dans Windows 8)

Voir aussi

SetupGetThreadLogToken

SetupWriteTextLogError

Partager via