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

Artigo
03/01/2024

O método GetTagByName pesquisa uma marca que tem um nome especificado.

Sintaxe

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

Parâmetros

[in] PluginId

Um ponteiro para uma cadeia de caracteres terminada em nulo que especifica o identificador de um plug-in de extensão de análise. Este parâmetro pode ser NULL.

[in] TagName

Um ponteiro para uma cadeia de caracteres terminada em nulo que especifica o nome a ser pesquisado.

[out] Tag

Um ponteiro para uma variável que recebe um valor na enumeração FA_TAG ou o valor de uma marca personalizada. Se esse método não encontrar uma marca que tenha o nome especificado, nada será gravado nesse parâmetro.

Retornar valor

Se esse método encontrar uma marca que tenha o nome especificado, ele retornará S_OK. Caso contrário, ele retornará um código de falha.

Comentários

Um objeto DebugFailureAnalysis tem uma coleção de entradas FA, cada uma com uma marca. Um objeto DebugFailureAnalysis está associado a um DebugFailureAnalysisTags, que contém uma coleção de propriedades de marca. Além disso, o mecanismo de análise tem uma tabela de marcas global. Para obter mais informações, consulte Entradas, marcas e tipos de dados de análise de falhas.

Se você especificar um PluginId, esse método fará o seguinte:

No objeto DebugFailureAnalysisTags , pesquise na coleção de propriedades de marca uma marca cujo nome corresponde a TagName e cuja ID de plug-in corresponde ao PluginId. Observe que isso limita a pesquisa a marcas personalizadas criadas pelo plug-in de extensão de análise identificado pelo PluginId. Se uma correspondência for encontrada, retorne a marca no parâmetro de saída Marca .
Se uma correspondência não for encontrada no objeto DebugFailureAnalysisTags , pesquise na tabela de marcas global uma marca cujo nome corresponde a TagName. Se um nome correspondente for encontrado, adicione a marca encontrada à coleção DebugFailureAnalysisTags de propriedades de marca e retorne a marca no parâmetro de saída Tag .
Se uma correspondência não for encontrada na tabela de marcas global, não escreva nada no parâmetro de saída Marca e retorne um código de falha.

Se você chamar esse método de um plug-in de extensão de análise e definir PluginId como NULL, esse método usará o identificador de plug-in do plug-in atual. Em seguida, ele se comporta da mesma maneira que quando um PluginId não NULL é especificado.