次の方法で共有

IAgentNotifySinkEx::HelpComplete

  • [アーティクル]

[Microsoft Agent は Windows 7 の時点で非推奨となり、後続のバージョンの Windows では使用できない可能性があります。]

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

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

  • 戻り値はありません。

dwCharID

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

dwCommandID

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

dwCause

イベントの原因。次の値になります。

値 説明
定数符号なしショート CSHELPCAUSE_COMMAND = 1;
 ユーザーはアプリケーションによって提供されたコマンドを選択しました。
定数符号なしショート CSHELPCAUSE_OTHERPROGRAM = 2;
 ユーザーは別のクライアントの コマンド オブジェクトを選択しました。
定数符号なしショート CSHELPCAUSE_OPENCOMMANDSWINDOW = 3;
 ユーザーは「Voice コマンドを開く」コマンドを選択しました。
定数符号なしショート CSHELPCAUSE_CLOSECOMMANDSWINDOW = 4;
 ユーザーは「Voice コマンドを閉じる」コマンドを選択しました。
定数符号なしショート CSHELPCAUSE_SHOWCHARACTER = 5;
 ユーザーは「CharacterName の表示」コマンドを選択しました。
定数符号なしショート CSHELPCAUSE_HIDECHARACTER = 6;
 ユーザーは、 CharacterName を非表示コマンドを選択しました。
定数符号なしショート CSHELPCAUSE_CHARACTER = 7;
 ユーザーが文字を選択（クリック）しました。

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

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

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

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

参照

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