IDebugFAEntryTags::GetTagByName-Methode (extsfns.h)

Artikel
02/06/2025

Die GetTagByName Methode sucht nach einem Tag mit einem angegebenen Namen.

Syntax

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

Parameter

[in] PluginId

Ein Zeiger auf eine mit Null beendete Zeichenfolge, die den Bezeichner eines Analyseerweiterungs-Plug-Ins angibt. Dieser Parameter kann NULL-sein.

[in] TagName

Ein Zeiger auf eine mit Null beendete Zeichenfolge, die den namen angibt, nach dem gesucht werden soll.

[out] Tag

Ein Zeiger auf eine Variable, die entweder einen Wert in der FA_TAG-Aufzählung oder den Wert eines benutzerdefinierten Tags empfängt. Wenn diese Methode kein Tag mit dem angegebenen Namen findet, wird nichts in diesen Parameter geschrieben.

Rückgabewert

Wenn diese Methode ein Tag mit dem angegebenen Namen findet, wird S_OKzurückgegeben. Andernfalls wird ein Fehlercode zurückgegeben.

Bemerkungen

Ein DebugFailureAnalysis--Objekt verfügt über eine Auflistung von FA-Einträgen, die jeweils über ein Tag verfügen. Ein DebugFailureAnalysis--Objekt ist einem DebugFailureAnalysisTags-zugeordnet, das eine Auflistung von Tageigenschaften enthält. Außerdem verfügt das Analysemodul über eine globale Tagtabelle. Weitere Informationen finden Sie unter Fehleranalyseeinträge, Tags und Datentypen.

Wenn Sie eine PluginId-angeben, führt diese Methode folgende Aktionen aus:

Durchsuchen Sie im DebugFailureAnalysisTags--Objekt die Auflistung der Tageigenschaften nach einem Tag, dessen Name TagName- entspricht und dessen Plug-In-ID der PluginIdentspricht. Beachten Sie, dass dadurch die Suche auf benutzerdefinierte Tags beschränkt wird, die vom Analyseerweiterungs-Plug-In erstellt wurden, das von PluginIdidentifiziert wird. Wenn eine Übereinstimmung gefunden wird, geben Sie das Tag im Tag Ausgabeparameter zurück.
Wenn eine Übereinstimmung im DebugFailureAnalysisTags--Objekt nicht gefunden wird, suchen Sie die globale Tagtabelle nach einem Tag, dessen Name TagName-entspricht. Wenn ein übereinstimmener Name gefunden wird, fügen Sie das gefundene Tag dem DebugFailureAnalysisTags Auflistung von Tageigenschaften hinzu, und geben Sie das Tag im Tag Ausgabeparameter zurück.
Wenn in der globalen Tagtabelle keine Übereinstimmung gefunden wird, schreiben Sie nichts in den Tag Ausgabeparameter, und geben Sie einen Fehlercode zurück.

Wenn Sie diese Methode aus einem Analyseerweiterungs-Plug-In aufrufen und PluginId- auf NULL-festlegen, verwendet diese Methode den Plug-In-Bezeichner des aktuellen Plug-Ins. Dann verhält es sich auf die gleiche Weise wie eine Nicht-NULL-PluginId- angegeben wird.