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