IPriorityFileEnumeratorFactory.GetEnumeratorFavoringPriorityFiles Method

Definition

Overloads

GetEnumeratorFavoringPriorityFiles(IFileEntityAsyncEnumerator, IReadOnlyList<FileEntity>)

Get an enumerator that returns first the given ordered priority files.

GetEnumeratorFavoringPriorityFiles(IFileEntityAsyncEnumerator, IReadOnlyList<FileEntity>, CancellationToken)

Get an enumerator that returns first the given ordered priority files.

GetEnumeratorFavoringPriorityFiles(IFileEntityAsyncEnumerator, IReadOnlyList<FileEntity>)

Get an enumerator that returns first the given ordered priority files.

public:
 Microsoft::VisualStudio::Shell::Internal::FileEnumerationService::IFileEntityAsyncEnumerator ^ GetEnumeratorFavoringPriorityFiles(Microsoft::VisualStudio::Shell::Internal::FileEnumerationService::IFileEntityAsyncEnumerator ^ fileEntityEnumerator, System::Collections::Generic::IReadOnlyList<Microsoft::VisualStudio::Shell::Internal::FileEnumerationService::FileEntity ^> ^ orderedPriorityFileEntities);
public Microsoft.VisualStudio.Shell.Internal.FileEnumerationService.IFileEntityAsyncEnumerator GetEnumeratorFavoringPriorityFiles (Microsoft.VisualStudio.Shell.Internal.FileEnumerationService.IFileEntityAsyncEnumerator fileEntityEnumerator, System.Collections.Generic.IReadOnlyList<Microsoft.VisualStudio.Shell.Internal.FileEnumerationService.FileEntity> orderedPriorityFileEntities);
abstract member GetEnumeratorFavoringPriorityFiles : Microsoft.VisualStudio.Shell.Internal.FileEnumerationService.IFileEntityAsyncEnumerator * System.Collections.Generic.IReadOnlyList<Microsoft.VisualStudio.Shell.Internal.FileEnumerationService.FileEntity> -> Microsoft.VisualStudio.Shell.Internal.FileEnumerationService.IFileEntityAsyncEnumerator
Public Function GetEnumeratorFavoringPriorityFiles (fileEntityEnumerator As IFileEntityAsyncEnumerator, orderedPriorityFileEntities As IReadOnlyList(Of FileEntity)) As IFileEntityAsyncEnumerator

Parameters

fileEntityEnumerator
IFileEntityAsyncEnumerator

Defines an enumerator where opened document must be merged to.

orderedPriorityFileEntities
IReadOnlyList<FileEntity>

Ordered list of file entity to prioritize to be enumerated first.

Returns

Returns an enumerator to get the next discovered file asynchronously.

Remarks

This enumerates everything in the given fileEntityEnumerator but return all the given orderedPriorityFileEntities first, if they exist in the enumerator.

Applies to

GetEnumeratorFavoringPriorityFiles(IFileEntityAsyncEnumerator, IReadOnlyList<FileEntity>, CancellationToken)

Get an enumerator that returns first the given ordered priority files.

public Microsoft.VisualStudio.Shell.Internal.FileEnumerationService.IFileEntityAsyncEnumerator GetEnumeratorFavoringPriorityFiles (Microsoft.VisualStudio.Shell.Internal.FileEnumerationService.IFileEntityAsyncEnumerator fileEntityEnumerator, System.Collections.Generic.IReadOnlyList<Microsoft.VisualStudio.Shell.Internal.FileEnumerationService.FileEntity> orderedPriorityFileEntities, System.Threading.CancellationToken cancellationToken = default);
abstract member GetEnumeratorFavoringPriorityFiles : Microsoft.VisualStudio.Shell.Internal.FileEnumerationService.IFileEntityAsyncEnumerator * System.Collections.Generic.IReadOnlyList<Microsoft.VisualStudio.Shell.Internal.FileEnumerationService.FileEntity> * System.Threading.CancellationToken -> Microsoft.VisualStudio.Shell.Internal.FileEnumerationService.IFileEntityAsyncEnumerator
Public Function GetEnumeratorFavoringPriorityFiles (fileEntityEnumerator As IFileEntityAsyncEnumerator, orderedPriorityFileEntities As IReadOnlyList(Of FileEntity), Optional cancellationToken As CancellationToken = Nothing) As IFileEntityAsyncEnumerator

Parameters

fileEntityEnumerator
IFileEntityAsyncEnumerator

Defines an enumerator where opened document must be merged to.

orderedPriorityFileEntities
IReadOnlyList<FileEntity>

Ordered list of file entity to prioritize to be enumerated first.

cancellationToken
CancellationToken

(optional) Cancellation token that can cancel IsInEnumerationAsync(FileEntity) and MoveNextAsync().

Returns

Returns an enumerator to get the next discovered file asynchronously.

Remarks

This enumerates everything in the given fileEntityEnumerator but return all the given orderedPriorityFileEntities first, if they exist in the enumerator.

Applies to