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

Article
02/06/2025

La méthode GetTagByName recherche une balise portant 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 portant le nom spécifié, rien n’est écrit dans ce paramètre.

Valeur de retour

Si cette méthode trouve une balise portant le nom spécifié, elle retourne S_OK. Sinon, elle 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 objet DebugFailureAnalysisTags, qui contient une collection de propriétés de balise. En outre, le moteur d’analyse a une table d’étiquettes globale. Pour plus d’informations, consultez entrées d’analyse des défaillances, balises et types de données.

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

Dans l’objet DebugFailureAnalysisTags, recherchez la collection de propriétés de balise pour une balise dont le nom correspond tagName et dont l’ID de plug-in correspond au PluginId. 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 de sortie balise.
Si une correspondance est introuvable dans l’objet DebugFailureAnalysisTags, recherchez la table de balises globale pour une balise dont le nom correspond TagName. Si un nom correspondant est trouvé, ajoutez la balise trouvée au DebugFailureAnalysisTags collection de propriétés de balise, puis retournez la balise dans le paramètre de sortie Balise.
Si aucune correspondance n’est trouvée dans la table de balises globale, n’écrivez rien dans le paramètre de sortie balise 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 plug-inid non NULL plug-inid est spécifié.