Метод IDebugFAEntryTags::GetTagByName (extsfns.h)

Статья
08/07/2023

Метод GetTagByName выполняет поиск тега с указанным именем.

Синтаксис

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

Параметры

[in] PluginId

Указатель на строку, завершающуюся значением NULL, которая указывает идентификатор подключаемого модуля расширения анализа. Этот параметр может принимать значение NULL.

[in] TagName

Указатель на строку, завершающуюся значением NULL, которая указывает имя для поиска.

[out] Tag

Указатель на переменную, которая получает значение в перечислении FA_TAG или значение настраиваемого тега. Если этот метод не находит тег с указанным именем, в этот параметр ничего не записывается.

Возвращаемое значение

Если этот метод находит тег с указанным именем, он возвращает S_OK. В противном случае возвращается код сбоя.

Объект DebugFailureAnalysis содержит коллекцию записей FA, каждая из которых имеет тег . Объект DebugFailureAnalysis связан с DebugFailureAnalysisTags, который содержит коллекцию свойств тегов. Кроме того, модуль анализа имеет таблицу глобальных тегов. Дополнительные сведения см. в разделе Записи, теги и типы данных анализа сбоев.

Если указать PluginId, этот метод выполняет следующие действия:

В объекте DebugFailureAnalysisTags выполните поиск в коллекции свойств тега, имя которого совпадает с TagName , а идентификатор подключаемого модуля — PluginId. Обратите внимание, что при этом поиск ограничивается пользовательскими тегами, созданными подключаемым модулем расширения анализа, определяемым идентификатором PluginId. Если совпадение найдено, верните тег в выходном параметре Tag .
Если совпадение не найдено в объекте DebugFailureAnalysisTags , выполните поиск тега в глобальной таблице тегов, имя которого совпадает с TagName. Если найдено соответствующее имя, добавьте тег found в коллекцию свойств тегов DebugFailureAnalysisTags и верните тег в выходном параметре Tag .
Если совпадение не найдено в таблице глобальных тегов, ничего не запишите в выходной параметр Tag и верните код сбоя.

Если вы вызываете этот метод из подключаемого модуля расширения анализа и задаете pluginId значение NULL, этот метод использует идентификатор подключаемого модуля текущего подключаемого модуля. Затем он ведет себя так же, как и при указании идентификатора подключаемого модуля, отличного от NULL.