Share via


MMCCtrl.TaskNotify method

The TaskNotify method sends a notification and data to the specified snap-in through that snap-in's IExtendTaskPad::TaskNotify method.

Syntax

MMCCtrl.TaskNotify( _
  ByVal szClsid, _
  ByVal pvArg, _
  ByVal pvParam _
)

Parameters

szClsid [in]

A string that contains the CLSID of the snap-in that receives the notification and the data in pvArg and pvParam. For notifications for a task, the CLSID of the snap-in that owns a task can be retrieved from the Clsid property of the task's MMCTask object. For notifications for a list view button, the CLSID of the snap-in that owns the list-view control can be retrieved from the Clsid property of the MMCListPadInfo object.

pvArg [in]

A VARIANT that contains information passed back to the snap-in specified by szClsid.

Taskpads using MMC taskpad templates or command IDs

For the MMC-supplied taskpads, the VARIANT structure contains the command ID for the task or list view button that was clicked on the taskpad. List view buttons apply only to list view taskpads.

The command ID for a task can be retrieved from the CommandID property of the task's MMCTask object. A task's command ID was specified in the nCommandID of the MMC_TASK structure passed in the IEnumTASK::Next method that MMC called when it retrieved the information for that task during the setup of the taskpad.

The command ID for a list view button can be retrieved from the NotifyID property of the MMCListPadInfo object. A list view button is the button specified in the szButtonText member of the MMC_LISTPAD_INFO passed in the IExtendTaskPad::GetListPadInfo method that MMC called when it was setting up the list view taskpad. The list view button's command ID was specified in the nCommandID member of MMC_LISTPAD_INFO.

Taskpads using custom HTML pages

For custom taskpads, the VARIANT can contain any data that the script on the custom HTML page wants to pass back to the snap-in.

pvParam [in]

A pointer to a VARIANT that contains information passed back to the snap-in specified by szClsid.

This parameter is not used by taskpads that use the MMC taskpad templates unless this method is called by a scriptlet in a task. However, it can be used by custom taskpads to pass an additional value back to the snap-in.

Return value

This method does not return a value.

Requirements

Redistributable
MMC 1.1 or later
Header
Mmc.h
DLL
Cic.dll