IAgentCommandsEx::SetHelpContextID

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

HRESULT SetHelpContextID(
   long ulHelpID  // ID for help topic
);

Command オブジェクトの HelpContextID を設定します。

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

ulHelpID

Command オブジェクトに関連付けられているヘルプ トピックのコンテキスト番号。コマンドの状況依存のヘルプを提供するために使用されます。

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

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

注意

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

 

参照

IAgentCommandsEx::GetHelpContextID, IAgentCharacterEx::SetHelpModeOn, IAgentCharacterEx::SetHelpFileName