TdhGetPropertySize, fonction (tdh.h)

Article
03/02/2024

Récupère la taille d’une ou plusieurs valeurs de propriété dans les données d’événement.

Syntaxe

TDHSTATUS TdhGetPropertySize(
  [in]  PEVENT_RECORD             pEvent,
  [in]  ULONG                     TdhContextCount,
  [in]  PTDH_CONTEXT              pTdhContext,
  [in]  ULONG                     PropertyDataCount,
  [in]  PPROPERTY_DATA_DESCRIPTOR pPropertyData,
  [out] ULONG                     *pPropertySize
);

Paramètres

[in] pEvent

Enregistrement d’événement passé à votre rappel EventRecordCallback . Pour plus d’informations, consultez la structure EVENT_RECORD .

[in] TdhContextCount

Nombre d’éléments dans pTdhContext.

[in] pTdhContext

Tableau de valeurs de contexte pour les événements WPP ou ETW classiques uniquement ; sinon, NULL. Pour plus d’informations, consultez la structure TDH_CONTEXT . Le tableau ne doit pas contenir de types de contexte en double.

[in] PropertyDataCount

Nombre de structures de descripteur de données dans pPropertyData.

[in] pPropertyData

Tableau de structures PROPERTY_DATA_DESCRIPTOR qui définissent la propriété dont vous souhaitez récupérer la taille.

Vous pouvez passer ce même tableau à la fonction TdhGetProperty pour récupérer les données de propriété.

Si vous récupérez la taille d’une propriété qui n’est pas membre d’une structure, vous pouvez spécifier un seul descripteur de données. Si vous récupérez la taille d’une propriété membre d’une structure, spécifiez un tableau de deux descripteurs de données (les structures ne peuvent pas contenir ou référencer d’autres structures). Pour plus d’informations sur la spécification de ce paramètre, consultez l’exemple de code ci-dessous.

[out] pPropertySize

Taille de la propriété, en octets. Utilisez cette valeur pour allouer la mémoire tampon passée dans le paramètre pBuffer de la fonction TdhGetProperty .

Valeur retournée

Retourne ERROR_SUCCESS en cas de réussite. Sinon, cette fonction retourne l’un des codes de retour suivants en plus d’autres.

Code de retour	Description
ERROR_NOT_FOUND	Le schéma de l’événement est introuvable ou le mappage spécifié est introuvable. Si vous avez utilisé une classe MOF pour définir votre événement, TDH recherche le schéma dans le référentiel WMI. Si vous avez utilisé un manifeste pour définir votre événement, TDH recherche dans les ressources du fournisseur. Si vous utilisez un manifeste, l’attribut resourceFileName de l’élément provider définit l’emplacement où TDH s’attend à trouver les ressources.
ERROR_INVALID_PARAMETER	Un ou plusieurs paramètres ne sont pas valides.
ERROR_FILE_NOT_FOUND	L’attribut resourceFileName dans le manifeste contient l’emplacement du binaire du fournisseur. Lorsque vous inscrivez le manifeste, l’emplacement est écrit dans le Registre. TDH n’a pas pu trouver le fichier binaire en fonction de l’emplacement inscrit.
ERROR_WMI_SERVER_UNAVAILABLE	Le service WMI n’est pas disponible.

Remarques

Si l’événement est un événement WPP ou ETW classique, vous pouvez spécifier les informations de contexte utilisées pour faciliter l’analyse des informations d’événement. L’événement est un événement WPP si l’indicateur EVENT_HEADER_FLAG_TRACE_MESSAGE est défini dans le membre Indicateurs de EVENT_HEADER (voir le membre EventHeader de EVENT_RECORD). L’événement est un événement ETW hérité si l’indicateur EVENT_HEADER_FLAG_CLASSIC_HEADER est défini.

Exemples

Pour obtenir un exemple montrant comment appeler cette fonction, consultez Utilisation de TdhGetProperty pour consommer des données d’événement.

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	tdh.h
Bibliothèque	Tdh.lib
DLL	Tdh.dll

Voir aussi

TdhGetProperty

Partager via