IAgentNotifySinkEx::HelpComplete

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

HRESULT HelpComplete(
   long dwCharID,     // character ID
   long dwCommandID,  // command ID
   long dwCause       // cause 
);

ユーザーがコマンドまたは文字を選択してヘルプ モードを完了したときに、クライアント アプリケーションに通知します。

• 戻り値はありません。

dwCharID

ヘルプ モードが完了した文字の識別子。

dwCommandID

ユーザーが選択したコマンドの識別子。

dwCause

イベントの原因は、次の値である可能性があります。

値	説明
const unsigned shortCSHELPCAUSE_COMMAND = 1;	ユーザーは、アプリケーションによって指定されたコマンドを選択しました。
const unsigned shortCSHELPCAUSE_OTHERPROGRAM = 2;	ユーザーが別のクライアントの Commands オブジェクトを選択しました。
const unsigned shortCSHELPCAUSE_OPENCOMMANDSWINDOW = 3;	ユーザーが [音声コマンドを開く] コマンドを選択しました。
const unsigned shortCSHELPCAUSE_CLOSECOMMANDSWINDOW = 4;	ユーザーが [音声コマンドを閉じる] コマンドを選択しました。
const unsigned shortCSHELPCAUSE_SHOWCHARACTER = 5;	ユーザーが [ CharacterName の表示] コマンドを選択しました。
const unsigned shortCSHELPCAUSE_HIDECHARACTER = 6;	ユーザーが [ CharacterName を非表示にする] コマンドを選択しました。
const unsigned shortCSHELPCAUSE_CHARACTER = 7;	ユーザーが文字を選択 (クリック) しました。

通常、ヘルプ モードは、ユーザーが文字をクリックまたはドラッグするか、文字のポップアップ メニューからコマンドを選択すると完了します。 別の文字または画面上の他の場所をクリックしても、ヘルプ モードは取り消されません。 文字のヘルプ モードを設定するクライアントは、 IAgentCharacter::HelpModeOn を False に設定することで、ヘルプ モードを取り消すことができます。 ( IAgentNotifySinkEx::HelpComplete イベントは トリガーされません)。

ユーザーがヘルプ モードで文字のポップアップ メニューからコマンドを選択すると、サーバーはメニューを削除し、コマンドの指定した HelpContextID でヘルプを呼び出して、このイベントを送信します。 状況依存 (What's This とも呼ばれます)ヘルプ ウィンドウがポインターの位置に表示されます。 ユーザーが音声入力でコマンドを選択すると、ヘルプ ウィンドウが文字の上に表示されます。 文字が画面外の場合、ウィンドウは、文字の現在の位置に最も近い画面に表示されます。

サーバーが dwCommandID を空の文字列 ("") として返す場合、ユーザーがサーバー指定のコマンドを選択したことを示します。

このイベントは、文字をヘルプ モードにするクライアント アプリケーションにのみ送信されます。

参照

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