MMCN_EXPANDSYNC message

The MMCN_EXPANDSYNC notification is introduced in MMC 1.1.

The MMCN_EXPANDSYNC notification message is sent to the snap-in's IComponentData implementation when MMC requires a scope item to be expanded synchronously.

At certain times (for example, when a console file is reloaded with a scope item expanded), MMC requires a scope item to be synchronously expanded and sends the snap-in the MMCN_EXPANDSYNC notification. Usually, MMC sends the MMCN_EXPAND notification when a item is expanded or collapsed.

Parameters

lpDataObject [in]

A pointer to the data object of the scope item that must be expanded or collapsed.

arg

Not used.

param [in]

A pointer to an MMC_EXPANDSYNC_STRUCT structure.

Return value

S_OK

The snap-in successfully handled the notification.

S_FALSE

The snap-in does not handle the notification. MMC then performs a default operation for the notification.

Remarks

If the snap-in normally responds to MMCN_EXPAND by expanding the scope item specified by lpDataObject asynchronously (that is, by spawning a thread to handle the expansion), the snap-in must also handle this notification. When the snap-in receives MMCN_EXPANDSYNC, it must expand the scope item before returning and set the bHandled member of MMC_EXPANDSYNC_STRUCT to TRUE.

If the snap-in always synchronously expands the scope item specified by lpDataObject, the snap-in can ignore this notification for this item and instead handle the MMCN_EXPAND notification. The default value for bHandled is FALSE. If the snap-in does not handle MMCN_EXPANDSYNC or returns with bHandled = FALSE, MMC will send an MMCN_EXPAND notification to the snap-in.

Requirements

See also

IComponentData::Notify

IConsoleNameSpace2

MMCN_EXPAND