EvtGetObjectArrayProperty-Funktion (winevt.h)

Artikel
08/27/2023

Ruft eine Anbietermetadateneigenschaft aus dem angegebenen Objekt im Array ab.

Syntax

BOOL EvtGetObjectArrayProperty(
  [in]  EVT_OBJECT_ARRAY_PROPERTY_HANDLE ObjectArray,
  [in]  DWORD                            PropertyId,
  [in]  DWORD                            ArrayIndex,
  [in]  DWORD                            Flags,
  [in]  DWORD                            PropertyValueBufferSize,
  [in]  PEVT_VARIANT                     PropertyValueBuffer,
  [out] PDWORD                           PropertyValueBufferUsed
);

Parameter

[in] ObjectArray

Ein Handle für ein Array von Objekten, das die EvtGetPublisherMetadataProperty-Funktion zurückgibt.

[in] PropertyId

Der Eigenschaftsbezeichner der Metadateneigenschaft, die Sie aus dem angegebenen Objekt abrufen möchten. Mögliche Werte finden Sie im Abschnitt Hinweise von EVT_PUBLISHER_METADATA_PROPERTY_ID.

[in] ArrayIndex

Der nullbasierte Index des Objekts im Array.

[in] Flags

Reserviert. Muss Null sein.

[in] PropertyValueBufferSize

Die Größe des PropertyValueBuffer-Puffers in Bytes.

[in] PropertyValueBuffer

Ein vom Aufrufer zugewiesener Puffer, der die Metadateneigenschaft empfängt. Der Puffer enthält ein EVT_VARIANT-Objekt . Sie können diesen Parameter auf NULL festlegen, um die erforderliche Puffergröße zu bestimmen.

[out] PropertyValueBufferUsed

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

Rückgabewert

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

Hinweise

Wenn Sie die Funktion EvtGetPublisherMetadataProperty mit den folgenden IDs aufrufen, gibt die Funktion ein Handle an ein Array von Objekten dieses Typs zurück:

EvtPublisherMetadataChannelReferences
EvtPublisherMetadataLevels
EvtPublisherMetadataTasks
EvtPublisherMetadataOpcodes
EvtPublisherMetadataKeywords

Wenn Sie beispielsweise EvtPublisherMetadataKeywords an EvtGetPublisherMetadataProperty übergeben, gibt die Funktion ein Handle an ein Array von Schlüsselwort (keyword)-Objekten zurück.

Um die Größe des Arrays zu bestimmen, rufen Sie die Funktion EvtGetObjectArraySize auf.

Beispiele

Ein Beispiel für die Verwendung dieser Funktion finden Sie unter Abrufen der Metadaten eines Anbieters.

Anforderungen

Anforderung	Wert
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

EVT_PUBLISHER_METADATA_PROPERTY_ID

EvtGetPublisherMetadataProperty

Freigeben über