Поделиться через

IAgentNotifySinkEx::HelpComplete

  • Статья

[Microsoft Agent не рекомендуется использовать в Windows 7 и может быть недоступно в последующих версиях 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;
 Пользователь выбрал команду Open Voice Commands.
const unsigned short CSHELPCAUSE_CLOSECOMMANDSWINDOW = 4;
 Пользователь выбрал команду "Закрыть голосовые команды".
const unsigned short CSHELPCAUSE_SHOWCHARACTER = 5;
 Пользователь выбрал команду Show CharacterName .
const unsigned short CSHELPCAUSE_HIDECHARACTER = 6;
 Пользователь выбрал команду Hide CharacterName .
const unsigned short CSHELPCAUSE_CHARACTER = 7;
 Пользователь выбрал (щелкнул) символ.

Обычно режим справки завершается, когда пользователь щелкает символ или перетаскивает символ или выбирает команду из всплывающего меню символа. Нажатие другого символа или другого места на экране не отменяет режим справки. Клиент, который задает режим справки для символа, может отменить режим справки, задав значение IAgentCharacter::HelpModeOn значение False. (Это не активирует Событие IAgentNotifySinkEx::HelpComplete .)

Когда пользователь выбирает команду из всплывающего меню символа в режиме справки, сервер удаляет меню, вызывает справку с указанной командой HelpContextID и отправляет это событие. Контекстно-чувствительный (также известный как что такое?) Окно справки отображается в расположении указателя. Если пользователь выбирает команду по голосовой вводу, окно справки отображается над символом. Если символ находится вне экрана, окно отображается на экране, ближайшее к текущей позиции символа.

Если сервер возвращает dwCommandID в виде пустой строки (""), он указывает, что пользователь выбрал команду, предоставленную сервером.

Это событие отправляется только клиентскому приложению, которое помещает символ в режим справки.

См. также

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