NdisWriteEventLogEntry, fonction (ndis.h)
NdisWriteEventLogEntry journalise un événement dans le journal des événements Win32.
Syntaxe
NDIS_STATUS NdisWriteEventLogEntry(
[in] PVOID LogHandle,
[in] NDIS_STATUS EventCode,
[in] ULONG UniqueEventValue,
[in] USHORT NumStrings,
[in, optional] PVOID StringsList,
[in] ULONG DataSize,
[in, optional] PVOID Data
);
Paramètres
[in] LogHandle
Pointeur vers l’objet pilote du protocole qui journalisation cet événement.
[in] EventCode
Spécifie le code NDIS_STATUS_XXX décrivant l’événement.
[in] UniqueEventValue
Identifie cette instance du message d’erreur.
[in] NumStrings
Spécifie le nombre de pointeurs vers des chaînes Unicode dans la StringsList facultative. Si StringsList est NULL, NumStrings doit être égal à zéro.
[in, optional] StringsList
NULL ou pointe vers des chaînes Unicode mises en mémoire tampon. Ces chaînes, qui décrivent l’événement, sont insérées dans le journal des événements Win32 et peuvent être examinées avec l’observateur d’événements Win32. Chaque chaîne doit être une chaîne Unicode terminée par un nul.
[in] DataSize
Spécifie le nombre d’octets dans la mémoire tampon pour les données binaires à data . Si data est NULL, DataSize doit être égal à zéro.
[in, optional] Data
NULL ou pointe vers des données de vidage binaire mises en mémoire tampon qui sont utiles pour comprendre l’événement. Ces données peuvent être examinées avec la visionneuse d’événements Win32.
Valeur de retour
NdisWriteEventLogEntry peut retourner l’une des valeurs suivantes :
| Retourner le code | Description |
|---|---|
|
L’événement a été correctement journalisé. |
|
Les chaînes Unicode et les données de vidage binaires fournies éventuellement dépassent la taille maximale autorisée (MAX_EVENT_LOG_DATA_SIZE). |
|
NDIS n’a pas pu allouer de mémoire pour l’enregistrement du journal des erreurs d’E/S. |
Remarques
NdisWriteEventLogEntry alloue un enregistrement de journal des erreurs d’E/S, renseigne l’enregistrement avec les informations fournies sur l’événement, puis écrit l’enregistrement dans le fichier journal des erreurs d’E/S. Un utilisateur peut afficher l’événement journalisé, y compris une description facultative de l’événement et/ou des données de vidage binaire facultatives, avec l’observateur d’événements Win32.
Le thread de journalisation des erreurs NT utilise toutes les chaînes fournies dans le stringsList facultatif pour renseigner les messages écrits dans le journal des événements Win32. Chaque chaîne doit être une chaîne Unicode terminée par un nul. Le gestionnaire d’E/S suppose que la chaîne initiale est soit le nom du pilote signalant l’erreur, soit le nom de l’appareil qui a provoqué l’erreur.
Les chaînes Unicode fournies par l’appelant doivent être lues à partir du registre ou doivent être indépendantes de la langue (autrement dit, les chaînes doivent être identiques dans n’importe quelle langue, par exemple, la chaîne peut être un nom de fichier).
Les données de vidage fournies par l’appelant peuvent être toutes les données binaires (telles que les valeurs d’inscription) utiles pour comprendre l’événement. L’appelant n’a pas besoin de remplir les données binaires. Si nécessaire, NdisWriteEventLogEntry pads les données de vidage binaire afin que la taille finale des données soit un multiple intégrale de taille de(ULONG).
Le système limite la taille totale des données facultatives fournies à NdisWriteEventLogEntry. La taille combinée de la liste des chaînes et du vidage binaire (éventuellement rembourré) doit être inférieure ou égale à MAX_EVENT_LOG_DATA_SIZE.
NdisWriteEventLogEntry est appelé uniquement par les pilotes de protocole. Les pilotes miniport doivent appeler NdisWriteErrorLogEntry pour journaliser les événements et les erreurs.