EvtGetObjectArrayProperty, fonction (winevt.h)

Article
08/27/2023

Obtient une propriété de métadonnées de fournisseur à partir de l’objet spécifié dans le tableau.

Syntaxe

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

Paramètres

[in] ObjectArray

Handle vers un tableau d’objets que la fonction EvtGetPublisherMetadataProperty retourne.

[in] PropertyId

Identificateur de propriété de la propriété de métadonnées que vous souhaitez obtenir à partir de l’objet spécifié. Pour connaître les valeurs possibles, consultez la section Remarques de EVT_PUBLISHER_METADATA_PROPERTY_ID.

[in] ArrayIndex

Index de base zéro de l’objet dans le tableau.

[in] Flags

Réservé. Doit être zéro.

[in] PropertyValueBufferSize

Taille de la mémoire tampon PropertyValueBuffer , en octets.

[in] PropertyValueBuffer

Mémoire tampon allouée à l’appelant qui recevra la propriété de métadonnées. La mémoire tampon contient un objet EVT_VARIANT . Vous pouvez définir ce paramètre sur NULL pour déterminer la taille de mémoire tampon requise.

[out] PropertyValueBufferUsed

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.

Valeur retournée

Code/valeur de retour	Description
TRUE	La fonction a réussi.
FALSE	Échec de la fonction. Pour obtenir le code d’erreur, appelez la fonction GetLastError .

Remarques

Lorsque vous appelez la fonction EvtGetPublisherMetadataProperty avec les ID suivants, la fonction retourne un handle à un tableau d’objets de ce type :

EvtPublisherMetadataChannelReferences
EvtPublisherMetadataLevels
EvtPublisherMetadataTasks
EvtPublisherMetadataOpcodes
EvtPublisherMetadataKeywords

Par exemple, si vous passez EvtPublisherMetadataKeywords à EvtGetPublisherMetadataProperty, la fonction retourne un handle à un tableau d’objets mot clé.

Pour déterminer la taille du tableau, appelez la fonction EvtGetObjectArraySize .

Exemples

Pour obtenir un exemple montrant comment utiliser cette fonction, consultez Obtention des métadonnées d’un fournisseur.

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

EVT_PUBLISHER_METADATA_PROPERTY_ID

EvtGetPublisherMetadataProperty

Partager via