Share via


VsSearchTask.SetTaskStatus Method

Helper function to set the task status.

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

Syntax

'Declaration
Protected Function SetTaskStatus ( _
    status As VSConstants.VsSearchTaskStatus _
) As Boolean
protected bool SetTaskStatus(
    VSConstants.VsSearchTaskStatus status
)
protected:
bool SetTaskStatus(
    VSConstants::VsSearchTaskStatus status
)
member SetTaskStatus : 
        status:VSConstants.VsSearchTaskStatus -> bool
protected function SetTaskStatus(
    status : VSConstants.VsSearchTaskStatus
) : boolean

Parameters

Return Value

Type: System.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).

.NET Framework Security

See Also

Reference

VsSearchTask Class

Microsoft.VisualStudio.Shell Namespace