IDebugControl2::SetTextReplacement メソッド (dbgeng.h)

SetTextReplacement メソッドは、ユーザー名のエイリアスの値を設定します。

構文

HRESULT SetTextReplacement(
  [in]           PCSTR SrcText,
  [in, optional] PCSTR DstText
);

[in] SrcText

ユーザー名のエイリアスの名前を指定します。デバッガーエンジンは、この文字列のコピーを作成します。 SrcText が自動エイリアスの名前と同じ場合、自動エイリアスは新しいユーザー名のエイリアスによって非表示になります。

[in, optional] DstText

ユーザー名のエイリアスの値を指定します。デバッガーエンジンは、この文字列のコピーを作成します。 DstText が NULL の場合、ユーザー名のエイリアスは削除されます。

このメソッドは、エラー値を返す場合もあります。詳細については、「戻り値」を参照してください。

リターンコード	説明
S_OK	メソッドは正常に実行されました。

コマンドを実行したり式を評価したりする前に、デバッガーエンジンは SrcText で指定されたエイリアスをエイリアスの値 ( DstText で指定) に置き換えます。

SrcText がアスタリスク (*) で DstText が NULL の場合、すべてのユーザー名のエイリアスが削除されます。これは RemoveTextReplacements メソッドと同じ動作です。

このメソッドによってエイリアスが変更されると、DEBUG_CES_TEXT_REPLACEMENTS フラグを IDebugEventCallbacks::ChangeEngineState コールバックメソッドに渡すことによって、イベントコールバックに通知されます。

デバッガーエンジンで使用されるエイリアスの概要については、「エイリアスの使用」を参照してください。デバッガーエンジン API でエイリアスを使用する方法の詳細については、「エンジンとの対話」を参照してください。

要件	値
対象プラットフォーム	デスクトップ
Header	dbgeng.h (Dbgeng.h を含む)