IDebugFAEntryTags::GetTagByName-Methode (extsfns.h)

Artikel
02/29/2024

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 NULL-endende Zeichenfolge, die den Bezeichner eines Analyseerweiterungs-Plug-Ins angibt. Dieser Parameter kann NULL sein.

[in] TagName

Ein Zeiger auf eine NULL-endende 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-Enumeration 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, gibt sie S_OK zurück. Andernfalls wird ein Fehlercode zurückgegeben.

Hinweise

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, der eine Auflistung von Tageigenschaften enthält. Außerdem verfügt die Analyse-Engine über eine globale Tagtabelle. Weitere Informationen finden Sie unter Fehleranalyseeinträge, Tags und Datentypen.

Wenn Sie eine Plug-In-Id angeben, führt diese Methode folgendes aus:

Durchsuchen Sie im DebugFailureAnalysisTags-Objekt die Auflistung der Tageigenschaften nach einem Tag, dessen Name tagName entspricht und dessen Plug-In-ID mit der Plug-In-ID übereinstimmt. Beachten Sie, dass die Suche auf benutzerdefinierte Tags beschränkt wird, die vom Analyseerweiterungs-Plug-In erstellt wurden, das durch Plug-In "Plug-In" identifiziert wird. Wenn eine Übereinstimmung gefunden wird, geben Sie das Tag im Ausgabeparameter Tag zurück.
Wenn im DebugFailureAnalysisTags-Objekt keine Übereinstimmung gefunden wird, suchen Sie in der globalen Tagtabelle nach einem Tag, dessen Name mit TagName übereinstimmt. Wenn ein übereinstimmender Name gefunden wird, fügen Sie das gefundene Tag der DebugFailureAnalysisTags-Auflistung der Tageigenschaften hinzu, und geben Sie das Tag im Ausgabeparameter Tag zurück.
Wenn in der globalen Tagtabelle keine Übereinstimmung gefunden wird, schreiben Sie nichts in den Ausgabeparameter Tag , 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 genauso wie, wenn eine Nicht-NULL-Plug-In-Id angegeben wird.