VsSearchTask::SetTaskStatus Method (VSConstants::VsSearchTaskStatus)

Visual Studio 2015
 

Helper function to set the task status.

Namespace:   Microsoft.VisualStudio.Shell
Assembly:  Microsoft.VisualStudio.Shell.14.0 (in Microsoft.VisualStudio.Shell.14.0.dll)

C#
C++
F#
VB
Copy 
protected:
bool SetTaskStatus(
	VSConstants::VsSearchTaskStatus status
)

Parameters

status
Type: Microsoft.VisualStudio::VSConstants::VsSearchTaskStatus

Status to be set.

Return Value

Type: System::Boolean

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).

Return to top
Show: