Compartir a través de

IAgentCharacterEx::GetHelpModeOn

  • Artículo

[Microsoft Agent está en desuso a partir de Windows 7 y puede no estar disponible en versiones posteriores de Windows].

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

Recupera si el modo ayuda contextual está activado para el carácter.

  • Devuelve S_OK para indicar que la operación se realizó correctamente.

pbHelpModeOn

Dirección de una variable que recibe True si el modo ayuda está activado para el carácter y False si no es así.

Cuando esta propiedad se establece en True, el puntero del mouse cambia a la imagen de Ayuda contextual cuando se mueve sobre el carácter o sobre el menú emergente del carácter. Cuando el usuario hace clic o arrastra el carácter o hace clic en un elemento en el menú emergente del carácter, el servidor desencadena el evento IAgentNotifySinkEx::HelpComplete y sale del modo ayuda.

En el modo ayuda, el servidor no envía los eventos IAgentNotifySink::Click, IAgentNotifySink::D ragStart, IAgentNotifySink::D ragComplete y IAgentNotifySink::Command , a menos que la propiedad GetAutoPopupMenu devuelva True. En ese caso, el servidor enviará el evento IAgentNotifySink::Click (no sale del modo Ayuda), sino solo para el botón derecho del mouse para permitirle mostrar el menú emergente.

Esta propiedad solo se aplica al uso del carácter de la aplicación cliente; la configuración no afecta a otros clientes del carácter u otros caracteres de la aplicación cliente.

Consulte también

IAgentCharacterEx::SetHelpModeOn