MMCN_CONTEXTHELP message

The MMCN_CONTEXTHELP notification message is sent to the snap-in's IComponent implementation when the user requests help about a selected item by pressing the F1 key or Help button.

A snap-in responds to MMCN_CONTEXTHELP by that displays a Help topic for the particular context by calling the IDisplayHelp::ShowTopic method.

Parameters

lpDataObject [in]

A pointer to the data object of the currently selected scope or result item.

arg

Zero.

param

Zero.

Return value

S_OK

The snap-in handles the notification message. See Remarks for details.

S_FALSE

The snap-in does not handle the notification message. MMC displays a default topic. See Remarks for details.

Remarks

If the snap-in handles the MMCN_CONTEXTHELP notification, MMC expects the snap-in to specify a Help topic for the selected item. Consequently, in the notification handler for MMCN_CONTEXTHELP notification, the snap-in has two options:

• It can call IDisplayHelp::ShowTopic or MMCPropertyHelp to specify the Help topic and then return S_OK to indicate success. Be aware that the snap-in should only return S_OK if it specifies a Help topic. If the snap-in returns S_OK without specifying a Help topic, no Help topic will be displayed.
• It can return S_FALSE to the notification. MMC then brings up the table of contents with the default MMC topic selected.

Requirements

See also

Adding HTML Help Support