IAgentCharacterEx::GetHelpModeOn
[Microsoft Agent является нерекомендуемым начиная с Windows 7 и может быть недоступен в последующих версиях Windows.]
HRESULT GetHelpModeOn(
long * pbHelpModeOn // address of help mode setting
);
Возвращает значение, указывая, включен ли контекстно-зависимый режим справки для символа.
- Возвращает S_OK, указывающее, что операция была успешной.
-
pbHelpModeOn
-
Адрес переменной, которая получает значение True , если для символа включен режим справки, и значение False , если нет.
Если для этого свойства задано значение True, указатель мыши меняется на контекстное изображение справки при перемещении по символу или по всплывающему меню для символа. Когда пользователь щелкает или перетаскивает символ или щелкает элемент во всплывающем меню символа, сервер активирует событие IAgentNotifySinkEx::HelpComplete и выходит из режима справки.
В режиме справки сервер не отправляет события IAgentNotifySink::Click, IAgentNotifySink::D ragStart, IAgentNotifySink::D ragComplete и IAgentNotifySink::Command , если только свойство GetAutoPopupMenu не возвращает значение True. В этом случае сервер отправит событие IAgentNotifySink::Click (не выходит из режима справки), а только для правой кнопки мыши, чтобы отобразить всплывающее меню.
Это свойство применяется только к использованию символа в клиентском приложении; Параметр не влияет на другие клиенты символа или другие символы клиентского приложения.
См. также:
IAgentCharacterEx::SetHelpModeOn