IAgentCharacterEx::GetHelpModeOn

[从 Windows 7 开始,Microsoft 代理已弃用,可能在后续版本的 Windows 中不可用。]

HRESULT GetHelpModeOn(
   long * pbHelpModeOn  // address of help mode setting
);

检索字符的上下文相关帮助模式是否处于打开状态。

  • 返回指示操作成功的S_OK。

pbHelpModeOn

如果字符的帮助模式处于打开状态,则为 True 的变量的地址,否则为 False

当此属性设置为 True 时,当鼠标指针移动到字符或字符的弹出菜单上时,鼠标指针将更改为上下文相关的帮助图像。 当用户单击或拖动字符或单击字符弹出菜单中的项时,服务器将触发 IAgentNotifySinkEx::HelpComplete 事件并退出帮助模式。

在帮助模式下,服务器不会发送 IAgentNotifySink::ClickIAgentNotifySink::D ragStartIAgentNotifySink::D ragCompleteIAgentNotifySink::Command 事件,除非 GetAutoPopupMenu 属性返回 True。 在这种情况下,服务器将发送 IAgentNotifySink::Click 事件, (不会退出帮助模式) ,而只会通过鼠标右键显示弹出菜单。

此属性仅适用于客户端应用程序对 字符的使用;设置不会影响该字符的其他客户端或客户端应用程序的其他字符。

另请参阅

IAgentCharacterEx::SetHelpModeOn