IFileEntityAsyncEnumerator2 Interface

Reference

Definition

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

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

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 IFileEntityAsyncEnumerator2 : Microsoft::VisualStudio::Shell::Internal::FileEnumerationService::IFileEntityAsyncEnumerator, Microsoft::VisualStudio::Threading::IAsyncDisposable

public interface IFileEntityAsyncEnumerator2 : Microsoft.VisualStudio.Shell.Internal.FileEnumerationService.IFileEntityAsyncEnumerator, Microsoft.VisualStudio.Threading.IAsyncDisposable

type IFileEntityAsyncEnumerator2 = interface
    interface IFileEntityAsyncEnumerator
    interface IAsyncDisposable

Public Interface IFileEntityAsyncEnumerator2
Implements IAsyncDisposable, IFileEntityAsyncEnumerator

Implements: IFileEntityAsyncEnumerator 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. (Inherited from IFileEntityAsyncEnumerator)
IsAccurate	Gets whether the enumerator provides an accurate list of file.
IsValid	Gets whether the enumerator is still valid or needs to be Reset(). When it's invalid, it means that the enumerator items changed. (Inherited from IFileEntityAsyncEnumerator)

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. (Inherited from IFileEntityAsyncEnumerator)
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. (Inherited from IFileEntityAsyncEnumerator)
Reset()	Restart the enumeration from the beginning with an up to date list of items to enumerate. (Inherited from IFileEntityAsyncEnumerator)

Events

Invalidated

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

(Inherited from IFileEntityAsyncEnumerator)

Applies to