ISolutionFileEnumeratorFactory2.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.
Overloads
| GetEnumerator(Boolean, Boolean, Boolean, Boolean, PathFilter, Action<Dictionary<String,Object>>) |
Get all files in the solution or opened folder. |
| GetEnumerator(Boolean, Boolean, Boolean, Boolean, Boolean, PathFilter, Action<Dictionary<String,Object>>, CancellationToken) |
Get all files in the solution or opened folder. |
GetEnumerator(Boolean, Boolean, Boolean, Boolean, PathFilter, Action<Dictionary<String,Object>>)
Get all files in the solution or opened folder.
public Microsoft.VisualStudio.Shell.Internal.FileEnumerationService.IFileEntityAsyncEnumerator2 GetEnumerator (bool allowInaccurateResult, bool includeMiscellaneousProject, bool includeHiddenItems, bool includeExternalItems, Microsoft.VisualStudio.Shell.Internal.FileEnumerationService.PathFilter? filter = default, Action<System.Collections.Generic.Dictionary<string,object>>? telemetryCallBack = default);abstract member GetEnumerator : bool * bool * bool * bool * Microsoft.VisualStudio.Shell.Internal.FileEnumerationService.PathFilter * Action<System.Collections.Generic.Dictionary<string, obj>> -> Microsoft.VisualStudio.Shell.Internal.FileEnumerationService.IFileEntityAsyncEnumerator2Public Function GetEnumerator (allowInaccurateResult As Boolean, includeMiscellaneousProject As Boolean, includeHiddenItems As Boolean, includeExternalItems As Boolean, Optional filter As PathFilter = Nothing, Optional telemetryCallBack As Action(Of Dictionary(Of String, Object)) = Nothing) As IFileEntityAsyncEnumerator2Parameters
- allowInaccurateResult
- Boolean
Indicates whether an inaccurate result is tolerated or not. Not allowing an inaccurate result might require to wait further time in order to get the result.
- includeMiscellaneousProject
- Boolean
Defines whether the miscellaneous project must be included.
- includeHiddenItems
- Boolean
Defines whether the hidden items must be included.
- includeExternalItems
- Boolean
Defines whether the external items must be included.
- 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.
Returns
Returns an enumerator to get the next discovered file asynchronously.
Applies to
GetEnumerator(Boolean, Boolean, Boolean, Boolean, Boolean, PathFilter, Action<Dictionary<String,Object>>, CancellationToken)
Get all files in the solution or opened folder.
public Microsoft.VisualStudio.Shell.Internal.FileEnumerationService.IFileEntityAsyncEnumerator2 GetEnumerator (bool allowInaccurateResult, bool allowDuplicates, bool includeMiscellaneousProject, bool includeHiddenItems, bool includeExternalItems, 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 : bool * bool * bool * bool * bool * Microsoft.VisualStudio.Shell.Internal.FileEnumerationService.PathFilter * Action<System.Collections.Generic.Dictionary<string, obj>> * System.Threading.CancellationToken -> Microsoft.VisualStudio.Shell.Internal.FileEnumerationService.IFileEntityAsyncEnumerator2Public Function GetEnumerator (allowInaccurateResult As Boolean, allowDuplicates As Boolean, includeMiscellaneousProject As Boolean, includeHiddenItems As Boolean, includeExternalItems As Boolean, Optional filter As PathFilter = Nothing, Optional telemetryCallBack As Action(Of Dictionary(Of String, Object)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As IFileEntityAsyncEnumerator2Parameters
- allowInaccurateResult
- Boolean
Indicates whether an inaccurate result is tolerated or not. Not allowing an inaccurate result might require to wait further time in order to get the result.
- allowDuplicates
- Boolean
Defines whether the duplicates results must be included.
- includeMiscellaneousProject
- Boolean
Defines whether the miscellaneous project must be included.
- includeHiddenItems
- Boolean
Defines whether the hidden items must be included.
- includeExternalItems
- Boolean
Defines whether the external items must be included.
- 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
Returns an enumerator to get the next discovered file asynchronously.