Determines whether context-sensitive help mode should be entered during an in-place activation session.
HRESULT ContextSensitiveHelp( BOOL fEnterMode );
TRUE if help mode should be entered; FALSE if it should be exited.
This method returns S_OK if the help mode was entered or exited successfully, depending on the value passed in fEnterMode. Other possible return values include the following.
||The specified fEnterMode value is not valid.|
||There is insufficient memory available for this operation.|
||An unexpected error has occurred.|
Applications can invoke context-sensitive help when the user:
- presses SHIFT+F1, then clicks a topic
- presses F1 when a menu item is selected
If an active object receives the SHIFT+F1 keystrokes, it calls the container's IOleWindow::ContextSensitiveHelp method with fEnterModeTRUE, which then recursively calls each of its in-place sites until there are no more to be notified. The container then calls its document's or frame's IOleWindow::ContextSensitiveHelp method with fEnterModeTRUE.
When in context-sensitive help mode, an object that receives the mouse click can either:
- Ignore the click if it does not support context-sensitive help.
- Tell all the other objects to exit context-sensitive help mode with ContextSensitiveHelp set to FALSE and then provide help for that context.
If a container application is to support context-sensitive help on menu items, it must either provide its own message filter so that it can intercept the F1 key or ask the OLE library to add a message filter by calling OleSetMenuDescriptor, passing valid, non-NULL values for the lpFrame and lpActiveObj parameters.
|Minimum supported client||Windows 2000 Professional [desktop apps only]|
|Minimum supported server||Windows 2000 Server [desktop apps only]|