Método IOleWindow::ContextSensitiveHelp (oleidl.h)

  • Artículo

Determina si se debe especificar el modo de ayuda contextual durante una sesión de activación local.

Sintaxis

HRESULT ContextSensitiveHelp(
  [in] BOOL fEnterMode
);

Parámetros

[in] fEnterMode

TRUE si se debe introducir el modo de ayuda; FALSE si se debe salir.

Valor devuelto

Este método devuelve S_OK si el modo de ayuda se especificó o salió correctamente, en función del valor pasado en fEnterMode. Otros posibles valores devueltos son los siguientes.

Código devuelto Descripción
E_INVALIDARG
 El valor fEnterMode especificado no es válido.
E_OUTOFMEMORY
 No hay memoria suficiente disponible para esta operación.
E_UNEXPECTED
 Se produjo un error inesperado.

Comentarios

Las aplicaciones pueden invocar ayuda contextual cuando el usuario:

  • presiona MAYÚS+F1 y, a continuación, hace clic en un tema.
  • presiona F1 cuando se selecciona un elemento de menú
Cuando se presiona MAYÚS+F1, el marco o el objeto activo pueden recibir las pulsaciones de tecla. Si el marco del contenedor recibe las pulsaciones de tecla, llama al método IOleWindow::ContextSensitiveHelp del documento que contiene con fEnterMode establecido en TRUE. Esto propaga el estado de ayuda a todos sus objetos en contexto para que puedan controlar correctamente el clic del mouse o WM_COMMAND.

Si un objeto activo recibe las pulsaciones de tecla MAYÚS+F1, llama al método IOleWindow::ContextSensitiveHelp del contenedor con fEnterModeTRUE, que llama de forma recursiva a cada uno de sus sitios en contexto hasta que no haya más que recibir notificaciones. A continuación, el contenedor llama al método IOleWindow::ContextSensitiveHelp de su documento o marco con fEnterModeTRUE.

Cuando se encuentra en modo de ayuda contextual, un objeto que recibe el clic del mouse puede:

  • Omita el clic si no admite ayuda contextual.
  • Indique a todos los demás objetos que salgan del modo de ayuda contextual con ContextSensitiveHelp establecido en FALSE y, a continuación, proporcione ayuda para ese contexto.
Un objeto en modo de ayuda contextual que recibe un WM_COMMAND debe indicar a todos los demás objetos en contexto que salgan del modo de ayuda contextual y, a continuación, proporcionar ayuda para el comando.

Si una aplicación contenedora es admitir ayuda contextual en los elementos de menú, debe proporcionar su propio filtro de mensajes para que pueda interceptar la tecla F1 o pedir a la biblioteca OLE que agregue un filtro de mensajes llamando a OleSetMenuDescriptor, pasando valores válidos y no NULL para los parámetros lpFrame y lpActiveObj .

Requisitos

Requisito Value
Cliente mínimo compatible Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino Windows
Encabezado oleidl.h

Consulte también

IOleWindow

OleSetMenuDescriptor