IAgentCharacterEx::GetHelpFileName
[Microsoft エージェントは Windows 7 の時点で非推奨となり、以降のバージョンの Windows では使用できない可能性があります。]
HRESULT GetHelpFileName(
BSTR * pbszName // address of Help filename
);
文字の HelpFileName を取得します。
- 操作が成功したことを示すS_OKを返します。
-
pbszNameを する
-
文字のヘルプ ファイル名を受け取る変数のアドレス。
アプリケーション用の Windows ヘルプ ファイルを作成し、文字の HelpFile プロパティを設定した場合、HelpModeOn が True に設定され、ユーザーが文字をクリックするか、ポップアップ メニューからコマンドを選択すると、Microsoft エージェントは自動的にヘルプを呼び出します。 選択したコマンドの HelpContextID プロパティにコンテキスト番号がある場合、ヘルプには現在のヘルプ コンテキストに対応するトピックが表示されます。それ以外の場合は、"このアイテムに関連付けられているヘルプ トピックがありません" と表示されます。
このプロパティは、クライアント アプリケーションによる文字の使用にのみ適用されます。この設定は、文字の他のクライアントやクライアント アプリケーションの他の文字には影響しません。
手記
ヘルプ ファイルをビルドするには、Microsoft Windows ヘルプ コンパイラが必要です。
関連項目
IAgentCommandsEx::SetHelpContextID, IAgentCharacterEx::SetHelpModeOn, IAgentCharacterEx::SetHelpFileName