EvtRender, fonction (winevt.h)

Article
08/27/2023

Affiche un fragment XML en fonction du contexte de rendu que vous spécifiez.

Syntaxe

BOOL EvtRender(
  [in]  EVT_HANDLE Context,
  [in]  EVT_HANDLE Fragment,
  [in]  DWORD      Flags,
  [in]  DWORD      BufferSize,
  [in]  PVOID      Buffer,
  [out] PDWORD     BufferUsed,
  [out] PDWORD     PropertyCount
);

Paramètres

[in] Context

Handle du contexte de rendu que la fonction EvtCreateRenderContext retourne. Ce paramètre doit avoir la valeur NULL si le paramètre Flags est défini sur EvtRenderEventXml ou EvtRenderBookmark.

[in] Fragment

Handle d’un événement ou d’un signet. Définissez ce paramètre sur un handle de signet si le paramètre Flags est défini sur EvtRenderBookmark ; sinon, définissez sur un handle d’événement.

[in] Flags

Indicateur qui identifie les éléments à restituer. Par exemple, l’événement entier ou les propriétés spécifiques de l’événement. Pour connaître les valeurs possibles, consultez l’énumération EVT_RENDER_FLAGS .

[in] BufferSize

Taille de la mémoire tampon , en octets.

[in] Buffer

Mémoire tampon allouée à l’appelant qui recevra la sortie rendue. Le contenu est une chaîne Unicode terminée par null si le paramètre Flags est défini sur EvtRenderEventXml ou EvtRenderBookmark. Sinon, si Flags est défini sur EvtRenderEventValues, la mémoire tampon contient un tableau de structures EVT_VARIANT ; une pour chaque propriété spécifiée par le contexte de rendu. Le paramètre PropertyCount contient le nombre d’éléments dans le tableau.

Vous pouvez définir ce paramètre sur NULL pour déterminer la taille de mémoire tampon requise.

[out] BufferUsed

Taille, en octets, de la mémoire tampon allouée à l’appelant utilisée par la fonction ou de la taille de mémoire tampon requise si la fonction échoue avec ERROR_INSUFFICIENT_BUFFER.

[out] PropertyCount

Nombre de propriétés dans le paramètre Buffer si le paramètre Flags est défini sur EvtRenderEventValues ; sinon, zéro.

Valeur retournée

Code/valeur de retour	Description
TRUE	La fonction a réussi.
FALSE	La fonction a échoué. Appelez la fonction GetLastError pour obtenir le code d’erreur.

Remarques

Il existe une relation un-à-un entre le tableau d’expressions XPath que vous avez spécifié lorsque vous avez appelé la fonction EvtCreateRenderContext et le tableau dont les valeurs sont retournées dans la mémoire tampon.

Lorsqu’un EVT_HANDLE de cette fonction est utilisé dans la fonction EvtRender , la liste des valeurs retournées par cette fonction se compose d’un tableau de structures EVT_VARIANT , chacune correspondant à l’une des expressions XPATH du tableau de paramètres ValuePaths d’origine par ordre d’apparence. Chaque structure de EVT_VARIANT contient la valeur identifiée par son expression XPATH correspondante pour l’événement qui est rendu. Si aucune valeur n’est trouvée, la structure EVT_VARIANT contient NULL. Si plusieurs valeurs sont présentes, la structure EVT_VARIANT contient la première valeur rencontrée.

Soyez prudent lorsque vous comparez des nombres à virgule flottante dans des requêtes XPath. Toute représentation sous forme de chaîne d’un nombre à virgule flottante étant approximative, la valeur affichée dans XML peut ne pas correspondre au nombre stocké avec l’événement. Les nombres à virgule flottante doivent être comparés comme étant inférieurs ou supérieurs à une constante.

Exemples

Pour obtenir un exemple qui montre comment utiliser cette fonction, consultez Événements de rendu et Événements de signet.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2008 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	winevt.h
Bibliothèque	Wevtapi.lib
DLL	Wevtapi.dll

Voir aussi

EvtCreateRenderContext

Partager via