IDebugFAEntryTags::GetTagByName メソッド (extsfns.h)

[アーティクル]
03/05/2024

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 と一致し、プラグイン ID が PluginId と一致するタグを検索します。これにより、 PluginId で識別される分析拡張機能プラグインによって作成されたカスタムタグに検索が制限されることに注意してください。一致するものが見つかった場合は、 Tag 出力パラメーターでタグを返します。
DebugFailureAnalysisTags オブジェクトに一致するものが見つからない場合は、グローバルタグテーブルで、名前が TagName と一致するタグを検索します。一致する名前が見つかった場合は、見つかったタグをタグプロパティの DebugFailureAnalysisTags コレクションに 追加し、 Tag 出力パラメーターでタグを返します。
グローバルタグテーブルに一致するものが見つからない場合は、 Tag 出力パラメーターに何も書き込まず、エラーコードを返します。