IAgentCharacterEx::SetHelpContextID

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

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

文字の HelpContextID を設定します。

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

ulHelpID

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

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

この設定は、クライアント アプリケーションが最上位文字のアクティブなクライアントである場合にのみ適用されます。 これは、クライアント アプリケーションで使用されている文字や他の文字の他のクライアントには影響しません。

Note

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

 

参照

IAgentCharacterEx::GetHelpContextID、 IAgentCharacterEx::SetHelpModeOn、 IAgentCharacterEx::SetHelpFileName