IProjectFileEnumeratorFactory2.GetQueue Method

Definition

Get all files in a specified project.

public Microsoft.VisualStudio.Shell.Internal.FileEnumerationService.FileEntityAsyncQueue GetQueue (bool allowInaccurateResult, Guid projectId, bool includeHiddenItems, bool includeExternalItems, Microsoft.VisualStudio.Shell.Internal.FileEnumerationService.PathFilter? filter = default, Action<System.Collections.Generic.Dictionary<string,object>>? telemetryCallBack = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetQueue : bool * Guid * bool * bool * Microsoft.VisualStudio.Shell.Internal.FileEnumerationService.PathFilter * Action<System.Collections.Generic.Dictionary<string, obj>> * System.Threading.CancellationToken -> Microsoft.VisualStudio.Shell.Internal.FileEnumerationService.FileEntityAsyncQueue
Public Function GetQueue (allowInaccurateResult As Boolean, projectId As Guid, includeHiddenItems As Boolean, includeExternalItems As Boolean, Optional filter As PathFilter = Nothing, Optional telemetryCallBack As Action(Of Dictionary(Of String, Object)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As FileEntityAsyncQueue

Parameters

allowInaccurateResult
Boolean

Indicates whether an inaccurate result is tolerated or not. Not allowing an inaccurate result might require to wait further time in order to get the result.

projectId
Guid

The unique ID of the project.

includeHiddenItems
Boolean

Defines whether the hidden items must be included.

includeExternalItems
Boolean

Defines whether the external items must be included.

filter
PathFilter

(optional) Additional filter to apply.

telemetryCallBack
Action<Dictionary<String,Object>>

(optional) An optional method called when the result is completed. Its arguments provide health and performance telemetry.

cancellationToken
CancellationToken

(optional) Cancellation token to cancel the task.

Returns

Returns a thread-safe queue of file entries that will be asynchronously loaded and completed.

Applies to