Partager via

Appel de SetupWriteTextLog

  • Article

SetupWriteTextLog ajoute une seule entrée avec des informations sur un événement d’installation à un journal texte SetupAPI.

Comme décrit dans Format d’un corps de section de journal de texte, le format d’une entrée de journal se compose des champs suivants :

entry_prefix time_stamp event_category indentation formatted_message

Pour appeler SetupWriteTextLog, une application fournit les informations suivantes :

  • Jeton de journal pour une section d’un journal texte obtenue en appelant SetupGetThreadLogToken, ou l’un des jetons de journal définis par le système. Si le jeton de journal est associé à une section de journal texte, SetupWriteTextLog écrit l’entrée de journal dans cette section. Sinon, SetupWriteTextLog ajoute l’entrée de journal à une partie du journal qui n’est pas incluse dans une section de journal texte. En outre, si SetupWriteTextLog écrit une entrée de journal et dans quel journal de texte SetupWriteTextLog écrit l’entrée, dépend de la valeur du jeton de journal défini par le système.

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

  • Une des catégories d’événements décrites dans Activation des catégories d’événements pour un journal de texte. Si la catégorie d’événements de l’entrée est activée pour le journal de texte, SetupWriteTextLog ajoute l’entrée au journal de texte ; sinon, SetupWriteTextLog n’écrit pas l’entrée dans le journal de texte.

  • Valeur d’indicateur au niveau du bit OR de constantes définies par le système qui spécifient le niveau d’événement, la profondeur de retrait et s’il faut inclure un horodatage. Les niveaux d’événement sont décrits dans Définition du niveau d’événement pour un journal de texte. Si le niveau d’événement défini pour le journal de texte est supérieur ou égal au niveau d’événement de l’entrée, SetupWriteTextLog écrit une entrée de journal dans le journal texte ; Sinon, SetupWriteTextLog n’écrit pas d’entrée de journal dans le journal de texte. À l’aide de la mise en retrait, les messages mis en forme peuvent être organisés pour faciliter la lecture et la compréhension des informations d’une section. Pour plus d’informations, consultez Écriture d’entrées de journal mises en retrait.

  • Chaîne de format compatible printf qui met en forme à la fois le message et la liste des variables séparées par des virgules qui suivent la chaîne de format.

  • Liste de variables séparées par des virgules, dont les valeurs sont mises en forme par la chaîne de format compatible printf.

Pour obtenir un exemple sur la façon d’appeler SetupWriteTextLog pour consigner des informations sur un événement qui n’est pas une erreur ou un avertissement, consultez Écriture d’une entrée de journal d’informations.

Pour obtenir un exemple sur la façon d’appeler SetupWriteTextLog pour consigner des informations sur une erreur ou un avertissement, consultez Écriture d’une erreur ou d’une entrée de journal d’avertissement.