IOpenDocumentEnumeratorFactory.GetQueue(PathFilter, CancellationToken) Method

Definition

Get all open documents.

public Microsoft.VisualStudio.Threading.AsyncQueue<Microsoft.VisualStudio.Shell.Internal.FileEnumerationService.FileEntity> GetQueue (Microsoft.VisualStudio.Shell.Internal.FileEnumerationService.PathFilter filter = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetQueue : Microsoft.VisualStudio.Shell.Internal.FileEnumerationService.PathFilter * System.Threading.CancellationToken -> Microsoft.VisualStudio.Threading.AsyncQueue<Microsoft.VisualStudio.Shell.Internal.FileEnumerationService.FileEntity>
Public Function GetQueue (Optional filter As PathFilter = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncQueue(Of FileEntity)

Parameters

filter
PathFilter

(optional) Additional filter to apply.

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.

Remarks

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

Applies to