IOpenDocumentEnumeratorFactory2.GetQueue Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Internal.FileEnumerationService

Assembly:: Microsoft.VisualStudio.Shell.15.0.dll

Package:: Microsoft.VisualStudio.Shell.15.0 v17.12.40392

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Get all open documents.

public Microsoft.VisualStudio.Threading.AsyncQueue<Microsoft.VisualStudio.Shell.Internal.FileEnumerationService.FileEntity> GetQueue (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 : Microsoft.VisualStudio.Shell.Internal.FileEnumerationService.PathFilter * Action<System.Collections.Generic.Dictionary<string, obj>> * System.Threading.CancellationToken -> Microsoft.VisualStudio.Threading.AsyncQueue<Microsoft.VisualStudio.Shell.Internal.FileEnumerationService.FileEntity>

Public Function GetQueue (Optional filter As PathFilter = Nothing, Optional telemetryCallBack As Action(Of Dictionary(Of String, Object)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncQueue(Of FileEntity)

Parameters

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

AsyncQueue<FileEntity>

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

Remarks

The current document, if there is one and it is eligible, will always be first.

Applies to

Partager via