VsSearchTask.Stop Method

Definition

Namespace:

Microsoft.VisualStudio.Shell

Assembly:

Microsoft.VisualStudio.Shell.15.0.dll

Package:

Microsoft.VisualStudio.Shell.15.0 v17.12.40392

Stops the search task

public:
 virtual void Stop();

public:
 void Stop();

void Stop();

public void Stop ();

abstract member Stop : unit -> unit
override this.Stop : unit -> unit

Public Sub Stop ()

Implements

Stop()

Remarks

This method implements Stop and sets the task status to Stopped. If this is possible (that is, the search has not already completed or the task was not already stopped), the method calls OnStopSearch allowing derived classes to override it and perform specific stop actions. Ultimately, this method calls the search callback (identified by SearchCallback) to report completion with the number of search results (in SearchResults) set by the derived classes.