IAgentCommandsEx::GetHelpContextID

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

HRESULT GetHelpContextID(
   long * pulHelpID  // address of Commands object help topic ID
);

Command オブジェクトの HelpContextID を取得します。

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

pulHelpID

Command オブジェクトのヘルプ トピックのコンテキスト番号を受け取る変数のアドレス。

アプリケーション用の Windows ヘルプ ファイルを作成し、文字の HelpFile プロパティを設定した場合、 HelpModeOn が True に設定され、ユーザーが Command オブジェクトを選択すると、Microsoft エージェントは自動的にヘルプを呼び出します。 HelpContextID にコンテキスト番号がある場合、エージェントはヘルプを呼び出し、現在のコンテキスト番号で識別されるトピックを検索します。 現在のコンテキスト番号は、Command オブジェクトの HelpContextID の値です。

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

Note

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

 

参照

IAgentCommandsEx::SetHelpContextID、 IAgentCharacterEx::SetHelpModeOn、 IAgentCharacterEx::SetHelpFileName