通过

IAgentNotifySinkEx::HelpComplete

  • 项目

[自 Windows 7 起弃用 Microsoft Agent，在后续版本的 Windows 中可能不可用。]

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

当用户选择命令或字符以完成帮助模式时，通知客户端应用程序。

  • 无返回值。

dwCharID

为其完成帮助模式的字符的标识符。

dwCommandID

用户所选命令的标识符。

dwCause

事件的原因，它可能为以下值之一：

值 说明
const unsigned short CSHELPCAUSE_COMMAND = 1;
 用户选择了应用程序提供的命令。
const unsigned short CSHELPCAUSE_OTHERPROGRAM = 2;
 用户选择了其他客户端的 Commands 对象。
const unsigned short CSHELPCAUSE_OPENCOMMANDSWINDOW = 3;
 用户选择了“打开语音命令”命令。
const unsigned short CSHELPCAUSE_CLOSECOMMANDSWINDOW = 4;
 用户选择了“关闭语音命令”命令。
const unsigned short CSHELPCAUSE_SHOWCHARACTER = 5;
 用户选择了“显示 CharacterName”命令。
const unsigned short CSHELPCAUSE_HIDECHARACTER = 6;
 用户选择了“隐藏 CharacterName”命令。
const unsigned short CSHELPCAUSE_CHARACTER = 7;
 用户选择了（单击了）该字符。

通常，当用户单击或拖动字符，或从字符的弹出菜单中选择命令时，帮助模式便会结束。 单击其他字符或屏幕上的其他位置不会取消帮助模式。 为字符设置帮助模式的客户端可通过将 IAgentCharacter::HelpModeOn 设为 False 来取消帮助模式。 （此操作不会触发 IAgentNotifySinkEx::HelpComplete 事件。）

当用户在帮助模式下从字符的弹出菜单中选择命令时，服务器将删除菜单，使用命令的指定 HelpContextID 调用帮助，并发送此事件。 上下文敏感（也称为“这是什么？”）帮助窗口显示在指针位置。 如果用户通过语音输入选择命令，则“帮助”窗口会显示在字符上。 如果该字符不在屏幕上，窗口将显示在离该字符当前位置最近的屏幕上。

如果服务器返回 dwCommandID 以作为空字符串 ("")，则表示用户选择了服务器提供的命令。

此事件仅会发送到将字符置于帮助模式的客户端应用程序。

另请参阅

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