Méthode IDebugFAEntryTags ::GetProperties (extsfns.h)

Article
02/26/2024

La méthode GetProperties obtient le nom ou la description (ou les deux) d’une balise dans un objet DebugFailureAnalysisTags .

Syntaxe

HRESULT GetProperties(
            FA_TAG Tag,
  [out]     PSTR   Name,
  [in, out] PULONG NameSize,
  [out]     PSTR   Description,
  [in, out] PULONG DescSize,
  [out]     PULONG Flags
);

Paramètres

Tag

Valeur dans l’énumération FA_TAG . Cette méthode obtient le nom ou la description (ou les deux) de cette balise.

[out] Name

Pointeur vers une mémoire tampon qui reçoit une chaîne terminée par null qui est le nom de la balise. Si NameSize est inférieur à la longueur du nom de la balise, cette méthode copie uniquement les octets NameSize , y compris la marque de fin NULL , dans cette mémoire tampon.

[in, out] NameSize

Lors de l’entrée, ce paramètre spécifie la taille, en octets, de la mémoire tampon pointée par Nom. Lors de la sortie, ce paramètre reçoit la taille, en octets, du nom de la balise. Si la balise n’a pas de nom, ce paramètre reçoit la valeur 0.

Note Si Name a la valeur NULL, ce paramètre ne reçoit aucune information. Vous devez soit définir Name et NameSize sur des valeurs non NULL, soit définir les deux sur NULL.

[out] Description

Pointeur vers une mémoire tampon qui reçoit une chaîne terminée par null qui est la description de la balise. Si DescSize est inférieur à la longueur de la description de la balise, cette méthode copie uniquement les octets DescSize , y compris le terminateur NULL , dans cette mémoire tampon.

[in, out] DescSize

Lors de l’entrée, ce paramètre spécifie la taille, en octets, de la mémoire tampon pointée par Description. Lors de la sortie, ce paramètre reçoit la taille, en octets, de la description de la balise. Si la balise n’a pas de description, ce paramètre reçoit la valeur 0.

Note Si Description a la valeur NULL, ce paramètre ne reçoit aucune information. Vous devez définir Description et DescSize sur des valeurs non NULL ou définir les deux sur NULL.

[out] Flags

Réservé. Définissez ce paramètre sur NULL.

Valeur retournée

Les valeurs HRESULT retournées par cette méthode sont définies dans winerror.h et strsafe.h. Les valeurs retournées par cette méthode sont notamment les suivantes :

Code de retour	Description
S_OK	Cette méthode a correctement récupéré le nom ou la description demandé (ou les deux), et aucune troncation de la ou des chaînes demandées n’était requise.
STRSAFE_E_INSUFFICIENT_BUFFER	Cette méthode a récupéré le nom ou la description demandé (ou les deux), mais le nom ou la description a été tronqué.
STRSAFE_E_INVALID_PARAMETER	L’appelant a passé au moins un paramètre non valide.

Configuration requise

Condition requise	Valeur
Plateforme cible	Desktop (Expérience utilisateur)
En-tête	extsfns.h

Voir aussi

IDebugFAEntryTags

IDebugFailureAnalysis2

SetProperties

Écriture d’un plug-in d’extension d’analyse pour Étendre !analyze

_EFN_Analyze

Partager via