次の方法で共有


IAgentCharacterEx::GetHelpContextID

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

HRESULT GetHelpContextID(
   long * pulHelpID  // address of character's help topic ID
);

文字の HelpContextID を取得します。

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

pulHelpID

文字のヘルプ トピックのコンテキスト番号を受け取る変数のアドレス。

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

IAgentCharacterEx::GetHelpContextID は、文字に設定した HelpContextID を返します。 他のクライアントによって設定された HelpContextID は 返されません。

Note

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

 

参照

IAgentCharacterEx::SetHelpContextID, IAgentCharacterEx::SetHelpModeOn, IAgentCharacterEx::SetHelpFileName