Appeler SetupWriteTextLogInfLine

Une application peut appeler SetupWriteTextLogInfLine pour écrire une entrée de journal dans un journal de texte SetupAPI qui contient le texte d’une ligne de fichier INF spécifiée.

Pour appeler SetupWriteTextLogInfLine, 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 de journal de texte, SetupWriteTextLogInfLine écrit l’entrée de journal dans cette section. Sinon, SetupWriteTextLogInfLine ajoute l’entrée de journal à une partie du journal qui n’est pas incluse dans une section de journal de texte.

  En outre, si SetupWriteTextLogInfLine écrit une entrée de journal et dans quel journal de texte SetupWriteTextLogInfLine é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.

• Valeur d’indicateur qui est une OR au niveau du bit des 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, SetupWriteTextLogInfLine écrit une entrée de journal dans le journal de texte. Sinon, SetupWriteTextLogInfLine 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.

• Handle du fichier INF qui contient la ligne de fichier INF.

• Contexte de la ligne de fichier INF.

SetupWriteTextLogInfLine écrit une entrée de journal au format suivant :

entry_prefix time_stamp inf :indentation inf-line-text (inf-file-name line-number)

Où :

• Les champs entry_prefix, horodatage et retrait sont identiques à ceux décrits dans le format d’un corps de section de journal de texte.

• Le champ inf : spécifie la catégorie d’événement TXTLOG_INF. Les catégories d’événements sont décrites dans Activation des catégories d’événements pour un journal de texte.

• Le champ inf-line-text contient le texte de la ligne de fichier INF spécifiée.

• Le champ inf-file-name contient le nom du fichier INF qui contient la ligne de fichier INF spécifiée.

• Le champ de ligne indique que ce qui suit est un numéro de ligne dans le fichier INF.

• Le champ numéro de ligne contient le numéro de ligne de la ligne spécifiée dans le fichier INF.

L’exemple suivant montre comment une application peut généralement consigner le texte d’une ligne INF dans un journal de texte. La ligne INF de cet exemple est une ligne AddReg INF. L’application appelle SetupWriteTextLogInfLine, en fournissant les valeurs de paramètre d’entrée suivantes :

• LogToken est défini sur un jeton de journal retourné par SetupGetThreadLogToken ou sur un jeton de journal défini par le système.

• LogFlags est défini sur TXTLOG_DETAILS. Cet exemple n’inclut pas d’horodatage ni de modification de la profondeur de retrait. Dans l’exemple, la profondeur de retrait est de cinq espaces de texte monospace.

• InfHandle est défini sur un handle sur le fichier INF hidserv.inf. Ce handle est obtenu en appelant la fonction SetupOpenInfFile , qui est documentée dans le Kit de développement logiciel (SDK) de plateforme.

• Le contexte est défini sur le contexte de fichier INF de la ligne de fichier INF qui contient le texte « AddReg=HidServ_AddService_AddReg ». Un contexte de fichier INF pour la ligne est obtenu en appelant les fonctions SetupFindXxxLine , qui sont documentées dans le Kit de développement logiciel (SDK) de plateforme.

Les valeurs de LogToken et LogFlags affectent l’opération de SetupWriteTextLogInfLine de la même façon que celle décrite pour SetupWriteTextLog. En outre, SetupWriteTextLogInfLine utilise le catalogue d’événements TXTLOG_INF.

Pour cet exemple, le type d’entrée de journal que SetupWriteTextLogInfLine écrivait dans un journal texte :

   inf:      AddReg=HidServ_AddService_AddReg  (hidserv.inf line 98)