VsSearchTask Class

Base class for implementing search tasks used by search-able tool windows.

Inheritance Hierarchy

System.Object
Microsoft.VisualStudio.Shell.VsSearchTask

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

'Declaración
Public Class VsSearchTask _
    Implements IVsSearchTask

public class VsSearchTask : IVsSearchTask

The VsSearchTask type exposes the following members.

	Name	Description
	VsSearchTask	Initializes a new instance of the VsSearchTask class.

Top

	Name	Description
	ErrorCode	Gets or sets the error code describing the search result if the search task has completed with errors. If the task completes without errors, this property is set to zero (0).
	Id	Gets the search task identifier. The task identifier is the cookie passed in the VsSearchTask constructor when the task was created.
	SearchCallback	Gets the callback interface that needs to be called when the search is complete.
	SearchQuery	Gets the search query used by the search task.
	SearchResults	Gets or sets the number of search results found. Set this value appropriately as the search progresses.
	TaskStatus	Gets the status of the current search. This property is set to appropriate values as the search progresses.

Top

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnStartSearch	Called on background threads when the search is started. Override to do task-specific search.
	OnStopSearch	Called on the UI thread when the search is stopped. Override to do task-specific stop actions.
	SetTaskStatus	Helper function to set the task status.
	Start	Starts the search task.
	Stop	Stops the search task.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

	Name	Description
	IVsSearchTask.Status	Gets the task status.

Top

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.