Appel de SetupWriteTextLog

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

Comme décrit dans le 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 d’une section dans un journal texte obtenu 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 du journal de 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 de texte. En outre, le fait que SetupWriteTextLog écrive une entrée de journal, ainsi que le journal de texte dans lequel SetupWriteTextLog écrit l’entrée, dépendent de la valeur du jeton de journal défini par le système.

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

• Une des catégories d’événements décrites dans Activer les catégories d’événements pour un journal de texte. Si la catégorie d’événement 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 qui est un élément OR au niveau du bit des constantes définies par le système qui spécifient le niveau d’événement, la profondeur de mise en retrait et l’inclusion d’un horodatage ou non. 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 de texte ; sinon, SetupWriteTextLog n’écrit pas d’entrée de journal dans le journal de texte. En utilisant 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 en retrait.

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

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

Pour obtenir un exemple sur la façon d’appeler SetupWriteTextLog pour journaliser 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 journaliser des informations sur une erreur ou un avertissement, consultez Écriture d’une entrée de journal d’erreur ou d’avertissement.