Partager via

IFindFilesService3.FindFilesAsync Method

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.Workspace
Assembly:
Microsoft.VisualStudio.Workspace.dll
Package:
Microsoft.VisualStudio.Workspace v17.12.18

Searches the workspace and asks all providers during runtime for files matching a pattern.

public System.Threading.Tasks.Task FindFilesAsync (string query, IProgress<string> progress, bool showAllFiles, System.Threading.CancellationToken cancellationToken = default);
abstract member FindFilesAsync : string * IProgress<string> * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Function FindFilesAsync (query As String, progress As IProgress(Of String), showAllFiles As Boolean, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

query
String

The query to match filenames on. It may be matched based on substring, or a richer parsing of the files.

progress
IProgress<String>

Receives the full path to each file as it is discovered.

showAllFiles
Boolean

If false, files that have been excluded from indexing (Example git ignore files.) will be ignored. If true, on the other hand, the search will look at all files in the workspace.

cancellationToken
CancellationToken

A token whose cancellation will cancel the query.

Returns

Task

A task that completes when all match files have been reported.

Applies to