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

Article
02/29/2024

La méthode GetTagByName recherche une balise qui a un nom spécifié.

Syntaxe

HRESULT GetTagByName(
  [in]  PCSTR  PluginId,
  [in]  PCSTR  TagName,
  [out] FA_TAG *Tag
);

Paramètres

[in] PluginId

Pointeur vers une chaîne terminée par null qui spécifie l’identificateur d’un plug-in d’extension d’analyse. Ce paramètre peut être NULL.

[in] TagName

Pointeur vers une chaîne terminée par null qui spécifie le nom à rechercher.

[out] Tag

Pointeur vers une variable qui reçoit une valeur dans l’énumération FA_TAG ou la valeur d’une balise personnalisée. Si cette méthode ne trouve pas de balise qui porte le nom spécifié, rien n’est écrit dans ce paramètre.

Valeur retournée

Si cette méthode trouve une balise qui porte le nom spécifié, elle retourne S_OK. Sinon, il retourne un code d’échec.

Remarques

Un objet DebugFailureAnalysis a une collection d’entrées FA, chacune ayant une balise. Un objet DebugFailureAnalysis est associé à un DebugFailureAnalysisTags, qui contient une collection de propriétés de balise. En outre, le moteur d’analyse a une table de balises globale. Pour plus d’informations, consultez Entrées, balises et types de données d’analyse des échecs.

Si vous spécifiez un PluginId, cette méthode effectue les opérations suivantes :

Dans l’objet DebugFailureAnalysisTags , recherchez une balise dont le nom correspond à TagName et dont l’ID de plug-in correspond à l’Id de plug-in. Notez que cela limite la recherche aux balises personnalisées créées par le plug-in d’extension d’analyse identifié par PluginId. Si une correspondance est trouvée, retournez la balise dans le paramètre Sortie de balise .
Si aucune correspondance n’est trouvée dans l’objet DebugFailureAnalysisTags , recherchez dans la table de balises globales une balise dont le nom correspond à TagName. Si un nom correspondant est trouvé, ajoutez la balise trouvée à la collection DebugFailureAnalysisTags des propriétés de balise et retournez la balise dans le paramètre de sortie Tag .
Si aucune correspondance n’est trouvée dans la table de balise globale, n’écrivez rien dans le paramètre de sortie tag et retournez un code d’échec.

Si vous appelez cette méthode à partir d’un plug-in d’extension d’analyse et que vous définissez PluginId sur NULL, cette méthode utilise l’identificateur de plug-in du plug-in actuel. Ensuite, il se comporte de la même façon qu’il le fait lorsqu’un PluginId non NULL est spécifié.