Share via

IVsTaskStatusCenterService.PreRegister Method

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.TaskStatusCenter
Assembly:
Microsoft.VisualStudio.Shell.Framework.dll
Package:
Microsoft.VisualStudio.Shell.Framework v17.11.40262

PreRegister configures an initial ITaskHandler based on the TaskHandlerOptions and TaskProgressData passed in. The TaskHandlerOptions will be immutable for the life time of the task. The TaskProgressData are mutable, and can be updated via the Progress.

public:
 Microsoft::VisualStudio::TaskStatusCenter::ITaskHandler ^ PreRegister(Microsoft::VisualStudio::TaskStatusCenter::TaskHandlerOptions options, Microsoft::VisualStudio::TaskStatusCenter::TaskProgressData data);
public Microsoft.VisualStudio.TaskStatusCenter.ITaskHandler PreRegister (Microsoft.VisualStudio.TaskStatusCenter.TaskHandlerOptions options, Microsoft.VisualStudio.TaskStatusCenter.TaskProgressData data);
abstract member PreRegister : Microsoft.VisualStudio.TaskStatusCenter.TaskHandlerOptions * Microsoft.VisualStudio.TaskStatusCenter.TaskProgressData -> Microsoft.VisualStudio.TaskStatusCenter.ITaskHandler
Public Function PreRegister (options As TaskHandlerOptions, data As TaskProgressData) As ITaskHandler

Parameters

options
TaskHandlerOptions

a TaskHandlerOptions dictating the immutable states, behaviours, and action of the ITaskHandler returned.

data
TaskProgressData

When a ITaskHandler is initialized, it has not been "reported" on yet via the Progress so an initial TaskProgressData can be passed in here.

Returns

ITaskHandler

Returns an ITaskHandler that can be used to register and update the the IVsTaskStatusCenterService UI's display regarding the task registered.

Applies to