IAgentCharacterEx::SetHelpFileName

  • [アーティクル]

[Microsoft エージェントは Windows 7 の時点で非推奨となり、以降のバージョンの Windows では使用できない場合があります。]

HRESULT SetHelpFileName(
   BSTR bszName  // Help filename
);

文字の HelpFileName を設定します。

  • 操作が成功したことを示すS_OKを返します。

bszName

文字のヘルプ ファイル名。

アプリケーション用に Windows ヘルプ ファイルを作成し、文字の HelpFile プロパティを設定した場合、 HelpModeOn が True に設定され、ユーザーがその文字をクリックするか、ポップアップ メニューからコマンドを選択すると、Microsoft エージェントによってヘルプが自動的に呼び出されます。 選択したコマンドの HelpContextID プロパティにコンテキスト番号がある場合、ヘルプには現在のヘルプ コンテキストに対応するトピックが表示されます。それ以外の場合は、"このアイテムに関連付けられているヘルプ トピックがありません" と表示されます。

このプロパティは、クライアント アプリケーションによる 文字の使用にのみ適用されます。設定は、文字の他のクライアントやクライアント アプリケーションの他の文字には影響しません。

注意

ヘルプ ファイルをビルドするには、Microsoft Windows ヘルプ コンパイラが必要です。

 

参照

IAgentCommandsEx::SetHelpContextID、 IAgentCharacterEx::SetHelpModeOn、 IAgentCharacterEx::GetHelpFileName