EvtRender-Funktion (winevt.h)

Rendert ein XML-Fragment basierend auf dem von Ihnen angegebenen Renderingkontext.

Syntax

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
);

Parameter

[in] Context

Ein Handle zum Renderkontext, den die EvtCreateRenderContext-Funktion zurückgibt. Dieser Parameter muss auf NULL festgelegt werden, wenn der Parameter "Flags " auf "EvtRenderEventXml" oder "EvtRenderBookmark" festgelegt ist.

[in] Fragment

Ein Handle zu einem Ereignis oder zu einer Textmarke. Legen Sie diesen Parameter auf ein Textmarke-Handle fest, wenn der Parameter "Flags " auf "EvtRenderBookmark" festgelegt ist; andernfalls auf ein Ereignishandle festgelegt.

[in] Flags

Ein Flag, das identifiziert, was gerendert werden soll. Beispielsweise das gesamte Ereignis oder bestimmte Eigenschaften des Ereignisses. Mögliche Werte finden Sie in der EVT_RENDER_FLAGS Enumeration.

[in] BufferSize

Die Größe des Pufferpuffers in Bytes.

[in] Buffer

Ein aufrufergeteilter Puffer, der die gerenderte Ausgabe empfängt. Der Inhalt ist eine null-beendete Unicode-Zeichenfolge, wenn der Parameter "Flags " auf "EvtRenderEventXml" oder "EvtRenderBookmark" festgelegt ist. Andernfalls enthält der Puffer ein Array von EVT_VARIANT Strukturen, wenn Flags auf EvtRenderEventValues festgelegt ist; eine für jede Eigenschaft, die durch den Renderingkontext angegeben wird. Der PropertyCount-Parameter enthält die Anzahl der Elemente im Array.

Sie können diesen Parameter auf NULL festlegen, um die erforderliche Puffergröße zu bestimmen.

[out] BufferUsed

Die Größe in Bytes des vom Aufrufer zugewiesenen Puffers, den die Funktion verwendet hat, oder die erforderliche Puffergröße, wenn die Funktion mit ERROR_INSUFFICIENT_BUFFER fehlschlägt.

[out] PropertyCount

Die Anzahl der Eigenschaften im Parameter "Buffer ", wenn der Parameter "Flags " auf "EvtRenderEventValues" festgelegt ist; andernfalls null.

Rückgabewert

Rückgabecode/-wert Beschreibung
TRUE
Die Funktion wurde erfolgreich ausgeführt.
FALSE
Fehler bei der Funktion. Rufen Sie die GetLastError-Funktion auf, um den Fehlercode abzurufen.

Hinweise

Es gibt eine 1:1-Beziehung zwischen dem Array von XPath-Ausdrücken, die Sie beim Aufrufen der EvtCreateRenderContext-Funktion und des Arrays angegeben haben, das im Puffer zurückgegeben wird.

Wenn eine EVT_HANDLE aus dieser Funktion in der Funktion EvtRender verwendet wird, besteht die Liste der Werte, die von dieser Funktion zurückgegeben werden, aus einem Array von EVT_VARIANT Strukturen, die jeweils genau einem der XPATH-Ausdrücke im ursprünglichen ValuePaths-Parameterarray entsprechen, in der Reihenfolge der Darstellung. Jede solche EVT_VARIANT Struktur enthält den Wert, der durch den entsprechenden XPATH-Ausdruck für das gerenderte Ereignis identifiziert wird. Wenn kein Wert gefunden wird, enthält die EVT_VARIANT Struktur NULL. Wenn mehrere Werte vorhanden sind, enthält die EVT_VARIANT Struktur den ersten gefundenen Wert.

Achten Sie beim Vergleichen von Gleitkommazahlen in XPath-Abfragen. Jede Zeichenfolgendarstellung einer Gleitkommanummer ist ungefähr, sodass der in XML angezeigte Wert möglicherweise nicht mit der mit dem Ereignis gespeicherten Zahl übereinstimmt. Gleitkommazahlen sollten als kleiner oder größer als eine Konstante verglichen werden.

Beispiele

Ein Beispiel für die Verwendung dieser Funktion finden Sie unter Renderereignisse und Lesezeichenereignisse.

Anforderungen

   
Unterstützte Mindestversion (Client) Windows Vista [Nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows Server 2008 [Nur Desktop-Apps]
Zielplattform Windows
Kopfzeile winevt.h
Bibliothek Wevtapi.lib
DLL Wevtapi.dll

Weitere Informationen

EvtCreateRenderContext