IDebugFAEntryTags ::GetProperties, méthode (extsfns.h)

Article
02/06/2025

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 de 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 NameSize octets, y compris le fin de 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. En 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.

Remarque Si Nom a la valeur NULL, ce paramètre ne reçoit aucune information. Vous devez définir nom et NameSize sur des valeurs non NULL ou les définir 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 DescSize octets, y compris le fin de 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. En sortie, ce paramètre reçoit la taille, en octets, de la description de la balise. Si la balise n’a aucune description, ce paramètre reçoit la valeur 0.

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

[out] Flags

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

Valeur de retour

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 incluent, mais ne sont pas limitées aux éléments suivants :

Retourner le code	Description
S_OK	Cette méthode a récupéré avec succès le nom ou la description demandé (ou les deux), et aucune troncation de la chaîne ou des chaînes demandées n’a été 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.