Метод IOleWindow::ContextSensitiveHelp (oleidl.h)

Статья
08/25/2023

Определяет, следует ли вводить контекстно-зависимый режим справки во время сеанса активации на месте.

Синтаксис

HRESULT ContextSensitiveHelp(
  [in] BOOL fEnterMode
);

Параметры

[in] fEnterMode

ЗНАЧЕНИЕ TRUE , если необходимо ввести режим справки; FALSE , если необходимо выйти.

Возвращаемое значение

Этот метод возвращает S_OK, если режим справки был успешно введен или завершен, в зависимости от значения, переданного в fEnterMode. Другие возможные возвращаемые значения включают следующее.

Код возврата	Описание
E_INVALIDARG	Указанное значение fEnterMode недопустимо.
E_OUTOFMEMORY	Для этой операции недостаточно памяти.
E_UNEXPECTED	Произошла непредвиденная ошибка.

При нажатии клавиш SHIFT+F1 кадр или активный объект может получить нажатия клавиш. Если кадр контейнера получает нажатия клавиш, он вызывает метод IOleWindow::ContextSensitiveHelp , содержащий его документ, с параметром fEnterMode , равным TRUE. Это распространяет состояние справки на все объекты на месте, чтобы они могли правильно обрабатывать щелчки мыши или WM_COMMAND.

Если активный объект получает нажатия клавиш SHIFT+F1, он вызывает метод IOleWindow::ContextSensitiveHelp контейнера с fEnterModeTRUE, который затем рекурсивно вызывает каждый из своих сайтов на месте, пока больше не будет получать уведомления. Затем контейнер вызывает метод IOleWindow::ContextSensitiveHelp своего документа или фрейма с помощью fEnterModeTRUE.

В контекстном режиме справки объект, получающий щелчок мышью, может:

Игнорируйте щелчок, если он не поддерживает контекстно-зависимые справки.
Сообщите всем остальным объектам о выходе из контекстно-чувствительного режима справки с параметром ContextSensitiveHelp, для параметра ContextSensitiveHelp установлено значение FALSE , а затем предоставьте справку для этого контекста.

Объект в контекстно-чувствительном режиме справки, который получает WM_COMMAND должен сообщить всем остальным объектам на месте выйти из контекстно-чувствительного режима справки, а затем предоставить справку по команде.

Если приложение-контейнер поддерживает контекстно-чувствительную справку по пунктам меню, оно должно либо предоставить собственный фильтр сообщений, чтобы оно могло перехватывать ключ F1, либо попросить библиотеку OLE добавить фильтр сообщений, вызвав OleSetMenuDescriptor, передав допустимые значения, отличные от NULL для параметров lpFrame и lpActiveObj .

Требования

Требование	Значение
Минимальная версия клиента	Windows 2000 Professional [только классические приложения]
Минимальная версия сервера	Windows 2000 Server [только классические приложения]
Целевая платформа	Windows
Header	oleidl.h

См. также раздел

IOleWindow

OleSetMenuDescriptor