IOpenDocumentEnumeratorFactory2.GetEnumeratorFavoringOpenDocuments 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 an enumerator for all open documents.

public Microsoft.VisualStudio.Shell.Internal.FileEnumerationService.IFileEntityAsyncEnumerator GetEnumeratorFavoringOpenDocuments (Microsoft.VisualStudio.Shell.Internal.FileEnumerationService.IFileEntityAsyncEnumerator fileEntityEnumerator, Action<System.Collections.Generic.Dictionary<string,object>>? telemetryCallBack = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetEnumeratorFavoringOpenDocuments : Microsoft.VisualStudio.Shell.Internal.FileEnumerationService.IFileEntityAsyncEnumerator * Action<System.Collections.Generic.Dictionary<string, obj>> * System.Threading.CancellationToken -> Microsoft.VisualStudio.Shell.Internal.FileEnumerationService.IFileEntityAsyncEnumerator

Public Function GetEnumeratorFavoringOpenDocuments (fileEntityEnumerator As IFileEntityAsyncEnumerator, Optional telemetryCallBack As Action(Of Dictionary(Of String, Object)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As IFileEntityAsyncEnumerator

Parameters

fileEntityEnumerator: IFileEntityAsyncEnumerator

Defines an enumerator where opened document must be merged to.

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 that can cancel IsInEnumerationAsync(FileEntity) and MoveNextAsync().

Returns

IFileEntityAsyncEnumerator

Returns an enumerator to get the next discovered file asynchronously.

Remarks

This enumerates everything in fileEntityEnumerator but return all the open documents first, when they are part of the given fileEntityEnumerator.

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

Applies to

다음을 통해 공유