MMC_RESTORE_VIEW structure (mmc.h)

The MMC_RESTORE_VIEW structure is introduced in MMC 1.1.

The MMC_RESTORE_VIEW structure contains information about a result pane view that must be restored by the snap-in when the user has navigated to a view displayed in the view history using the back or forward buttons.

Syntax

typedef struct _MMC_RESTORE_VIEW {
  DWORD      dwSize;
  MMC_COOKIE cookie;
  LPOLESTR   pViewType;
  long       lViewOptions;
} MMC_RESTORE_VIEW;

Members

dwSize

A value that specifies the size of the MMC_RESTORE_VIEW structure. A snap-in can use dwSize to check the version of the structure.

cookie

A value that specifies the cookie for the item that will be restored in the scope pane.

pViewType

A pointer to a string that specifies the view type used to display the result pane for the item specified by cookie. For more information about view types, see the ppViewType parameter for IComponent::GetResultViewType.

lViewOptions

A value that specifies the view option settings used to display the result pane for the item specified by cookie. For more information about view options, see the pViewOptions parameter of IComponent::GetResultViewType.

Remarks

MMC maintains a navigational history of the result pane. For each item in the history, MMC stores the view type and view options specified by IComponent::GetResultViewType when the result pane was originally displayed during the course of the current console session. When the back or forward buttons are used to navigate the history, MMC sends the snap-in that owns that item an MMCN_RESTORE_VIEW notification that has a pointer to an MMC_RESTORE_VIEW structure as its arg parameter and a pointer to a BOOL as its param parameter. The snap-in should handle that notification by setting the appropriate menu item in the View context menu, setting its internal view type state, and performing any initialization necessary to display the result pane as it appeared at that point in the view history.

Requirements

Requirement Value
Minimum supported client Windows Vista
Minimum supported server Windows Server 2008
Header mmc.h

See also

IComponent::GetResultViewType

IComponent::Notify

MMCN_RESTORE_VIEW