[Microsoft エージェントは Windows 7 の時点で非推奨となり、以降のバージョンの Windows では使用できない可能性があります。]
HRESULT SetHelpContextID(
long ulHelpID // ID for help topic
);
Command オブジェクトの HelpContextID を設定します。
- 操作が成功したことを示すS_OKを返します。
-
ulHelpIDを する
-
Command オブジェクトに関連付けられているヘルプ トピックのコンテキスト番号。コマンドの状況依存のヘルプを提供するために使用されます。
アプリケーションの Windows ヘルプ ファイルを作成し、文字の HelpFile プロパティで設定した場合。 HelpModeOn が True に設定され、ユーザーがコマンドを選択すると、エージェントは自動的にヘルプを呼び出します。 HelpContextIDにコンテキスト番号がある場合、エージェントはヘルプを呼び出し、現在のコンテキスト番号で識別されたトピックを検索します。 現在のコンテキスト番号は、コマンド HelpContextID の値です。 選択したコマンドの HelpContextID プロパティにコンテキスト番号がある場合、ヘルプには現在のヘルプ コンテキストに対応するトピックが表示されます。それ以外の場合は、"このアイテムに関連付けられているヘルプ トピックがありません" と表示されます。
このプロパティは、クライアント アプリケーションによる文字の使用にのみ適用されます。この設定は、文字の他のクライアントやクライアント アプリケーションの他の文字には影響しません。
手記
ヘルプ ファイルをビルドするには、Microsoft Windows ヘルプ コンパイラが必要です。
関連項目
IAgentCommandsEx::GetHelpContextID, IAgentCharacterEx::SetHelpModeOn, IAgentCharacterEx::SetHelpFileName