IFileEntityAsyncEnumerator Interface

Reference

Definition

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

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

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

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.

Provides a method to enumerate the next entry discovered by the service.

public interface class IFileEntityAsyncEnumerator : Microsoft::VisualStudio::Threading::IAsyncDisposable

public interface IFileEntityAsyncEnumerator : Microsoft.VisualStudio.Threading.IAsyncDisposable

public interface IFileEntityAsyncEnumerator : System.Collections.Generic.IAsyncEnumerator<Microsoft.VisualStudio.Shell.Internal.FileEnumerationService.FileEntity>

type IFileEntityAsyncEnumerator = interface
    interface IAsyncDisposable

type IFileEntityAsyncEnumerator = interface
    interface IAsyncEnumerator<FileEntity>
    interface IAsyncDisposable

Public Interface IFileEntityAsyncEnumerator
Implements IAsyncDisposable

Public Interface IFileEntityAsyncEnumerator
Implements IAsyncEnumerator(Of FileEntity)

Derived: Microsoft.VisualStudio.Shell.Internal.FileEnumerationService.IFileEntityAsyncEnumerator2

Implements: IAsyncDisposable IAsyncEnumerator<FileEntity> IAsyncDisposable

Properties

Current	Gets the current element of the enumeration. The returned value is undefined before the first call to MoveNextAsync(CancellationToken) and following a call to MoveNext that returned false. Multiple calls to Current with no intervening calls to MoveNextAsync(CancellationToken) will return the same object.
IsValid	Gets whether the enumerator is still valid or needs to be Reset(). When it's invalid, it means that the enumerator items changed.

Methods

DisposeAsync()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources asynchronously. (Inherited from IAsyncDisposable)
IsInEnumerationAsync(FileEntity, CancellationToken)	Gets a value that indicates whether the given `entity` exists in the current enumeration.
IsInEnumerationAsync(FileEntity)	Gets a value that indicates whether the given `entity` exists in the current enumeration.
MoveNextAsync(CancellationToken)	Returns the next file or folder in the enumeration. This method can be called from any thread but only one thread can call it at any one time.
Reset()	Restart the enumeration from the beginning with an up to date list of items to enumerate.

Events

Invalidated

Occurs when the enumerator items changed and that the enumerator needs to be Reset().

Applies to

Share via