VsSearchTask Class

 

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

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


public class VsSearchTask : IVsSearchTask

NameDescription
System_CAPS_pubmethodVsSearchTask(UInt32, IVsSearchQuery, IVsSearchCallback)

Initializes a new instance of the VsSearchTask class.

NameDescription
System_CAPS_pubpropertyErrorCode

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

System_CAPS_pubpropertyId

Gets the search task identifier. The task identifier is the cookie passed in the VsSearchTask constructor when the task was created.

System_CAPS_protpropertySearchCallback

Gets the callback interface that needs to be called when the search is complete.

System_CAPS_pubpropertySearchQuery

Gets the search query used by the search task.

System_CAPS_pubpropertySearchResults

Gets or sets the number of search results found. Set this value appropriately as the search progresses.

System_CAPS_pubpropertyTaskStatus

Gets the status of the current search. This property is set to appropriate values as the search progresses.

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_protmethodOnStartSearch()

Called on background threads when the search is started. Override to do task-specific search.

System_CAPS_protmethodOnStopSearch()

Called on the UI thread when the search is stopped. Override to do task-specific stop actions.

System_CAPS_protmethodSetTaskStatus(VSConstants.VsSearchTaskStatus)

Helper function to set the task status.

System_CAPS_pubmethodStart()

Starts the search task.

System_CAPS_pubmethodStop()

Stops the search task.

System_CAPS_pubmethodToString()

(Inherited from Object.)

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

Return to top
Show: