Fonction TdhGetWppProperty (tdh.h)

Article
03/02/2024

Récupère une propriété spécifique associée à un message WPP.

Syntaxe

TDHSTATUS TdhGetWppProperty(
  [in]      TDH_HANDLE    Handle,
  [in]      PEVENT_RECORD EventRecord,
  [in]      PWSTR         PropertyName,
  [in, out] PULONG        BufferSize,
  [out]     PBYTE         Buffer
);

Paramètres

[in] Handle

Type : TDH_HANDLE

Un handle de décodage valide.

[in] EventRecord

Type : PEVENT_RECORD

Enregistrement d’événement passé à votre rappel EventRecordCallback .

[in] PropertyName

Type : PWSTR

Nom de la propriété à récupérer.

Pour obtenir la liste des valeurs possibles, consultez PROPERTY_DATA_DESCRIPTOR.

[in, out] BufferSize

Type : PULONG

Taille du paramètre Buffer , en octets.

[out] Buffer

Type : PBYTE

Mémoire tampon allouée par l’utilisateur qui reçoit les données de propriété.

Valeur retournée

Type : ULONG

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	La propriété spécifiée est introuvable.
ERROR_INSUFFICIENT_BUFFER	BufferSize est trop petit. Pour obtenir la taille de mémoire tampon requise, appelez TdhGetWppProperty deux fois, une fois avec une mémoire tampon null et un pointeur pour récupérer la taille de la mémoire tampon, puis à nouveau avec la mémoire tampon correctement dimensionnée.
ERROR_INVALID_PARAMETER	Un ou plusieurs des paramètres sont incorrects. Cette erreur est retournée si le paramètre Handle, EventRecord, PropertyName ou Buffer a la valeur NULL.

Remarques

Pour récupérer uniquement le message d’événement décodé sans spécifier de nom de propriété, appelez TdhGetWppMessage.

Configuration requise

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

Voir aussi