IPathFileEnumeratorFactory.GetEnumerator Method
Definition
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 files in defined location(s).
public Microsoft.VisualStudio.Shell.Internal.FileEnumerationService.IFileEntityAsyncEnumerator GetEnumerator (System.Collections.Generic.IReadOnlyList<string> paths, bool includeSubfolders = true, Microsoft.VisualStudio.Shell.Internal.FileEnumerationService.PathFilter filter = default);
abstract member GetEnumerator : System.Collections.Generic.IReadOnlyList<string> * bool * Microsoft.VisualStudio.Shell.Internal.FileEnumerationService.PathFilter -> Microsoft.VisualStudio.Shell.Internal.FileEnumerationService.IFileEntityAsyncEnumerator
Public Function GetEnumerator (paths As IReadOnlyList(Of String), Optional includeSubfolders As Boolean = true, Optional filter As PathFilter = Nothing) As IFileEntityAsyncEnumerator
Parameters
- paths
- IReadOnlyList<String>
Defines a list of absolute folder path where the files must be retrieved.
- includeSubfolders
- Boolean
(optional) Defines whether the subfolders must be included or not. By default, this value is True
.
- filter
- PathFilter
(optional) Additional filter to apply.
Returns
Returns an enumerator to get the next discovered file asynchronously.
Remarks
This enumerator never gets invalidated.