SnapInCallbackService.RegisterSnapInHelpTopicCallback Method (SnapInBase, SnapInCallbackService.SnapInHelpTopicCallback)

This method is called by a snap-in to register a custom callback method with MMC. The custom callback method is subsequently invoked when help is requested for the snap-in and replaces the display of the standard MMC help.

Namespace:   Microsoft.ManagementConsole
Assembly:  Microsoft.ManagementConsole (in Microsoft.ManagementConsole.dll)

Syntax

public static void RegisterSnapInHelpTopicCallback(
    SnapInBase snapInInstance,
    SnapInCallbackService.SnapInHelpTopicCallback callback
)

public:
static void RegisterSnapInHelpTopicCallback(
    SnapInBase^ snapInInstance,
    SnapInCallbackService::SnapInHelpTopicCallback^ callback
)

static member RegisterSnapInHelpTopicCallback : 
        snapInInstance:SnapInBase *
        callback:SnapInCallbackService.SnapInHelpTopicCallback -> unit

Public Shared Sub RegisterSnapInHelpTopicCallback (
    snapInInstance As SnapInBase,
    callback As SnapInCallbackService.SnapInHelpTopicCallback
)

Parameters

• snapInInstance
  Type: Microsoft.ManagementConsole.SnapInBase

  The snap-in instance that is expected to provide the help functionality. This parameter cannot be null.

• callback
  Type: Microsoft.ManagementConsole.SnapInCallbackService.SnapInHelpTopicCallback

  The callback delegate for handling custom help. This parameter cannot be null.

Remarks

The custom call back method that is registered with MMC gets calls when a user right clicks a node and clicks Help, presses F1, or clicks the Help action available in the actions pane.

See Also

SnapInCallbackService Class
Microsoft.ManagementConsole Namespace

Return to top