IOpenDocumentEnumeratorFactory2.GetEnumerator 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 GetEnumerator (Microsoft.VisualStudio.Shell.Internal.FileEnumerationService.PathFilter? filter = default, Action<System.Collections.Generic.Dictionary<string,object>>? telemetryCallBack = default, System.Threading.CancellationToken cancellationToken = default);

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

Public Function GetEnumerator (Optional filter As PathFilter = Nothing, Optional telemetryCallBack As Action(Of Dictionary(Of String, Object)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As IFileEntityAsyncEnumerator

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

Returns

IFileEntityAsyncEnumerator

Returns an enumerator to get the next discovered file asynchronously.

Remarks

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

Applies to

Compartilhar via