VsSearchTask.SetTaskStatus(VSConstants+VsSearchTaskStatus) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell

Assembly:: Microsoft.VisualStudio.Shell.14.0.dll

Assembly:: Microsoft.VisualStudio.Shell.15.0.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Helper function to set the task status

protected:
 bool SetTaskStatus(Microsoft::VisualStudio::VSConstants::VsSearchTaskStatus status);

bool SetTaskStatus(Microsoft::VisualStudio::VSConstants::VsSearchTaskStatus status);

protected bool SetTaskStatus (Microsoft.VisualStudio.VSConstants.VsSearchTaskStatus status);

member this.SetTaskStatus : Microsoft.VisualStudio.VSConstants.VsSearchTaskStatus -> bool

Protected Function SetTaskStatus (status As VSConstants.VsSearchTaskStatus) As Boolean

Parameters

status: VSConstants.VsSearchTaskStatus

Returns

Boolean

Remarks

Setting to the new status to Started can only be done while the task is in the Created state. Setting to Stopped can only be done when the task is running (Started), or was created but not started yet (Created). Once the task status is set to Stopped, it cannot be taken out of that state. Error and Completed state can only be set when the task is started (Started).

Applies to