BrowseTree(IDirectoryContents2) Method

Browses a tree of subdirectories and (optionally) files in the given directory, recursively.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Overloads Shared Function BrowseTree( _
   ByVal directoryContents2 As IDirectoryContents2 _
) As ITreeTraversable(Of FileSystemNodeTreePosition)

'Usage
 
Dim directoryContents2 As IDirectoryContents2
Dim value As ITreeTraversable(Of FileSystemNodeTreePosition)
 
value = IDirectoryContents2Extension.BrowseTree(directoryContents2)

[Extension()]
[NotNull()]
public static ITreeTraversable<FileSystemNodeTreePosition> BrowseTree( 
   IDirectoryContents2 directoryContents2
)

[Extension()]
[NotNull()]
public:
static ITreeTraversable<FileSystemNodeTreePosition^>^ BrowseTree( 
   IDirectoryContents2^ directoryContents2
)

Parameters

directoryContents2: The directory contents object that will perform the operation.

Return Value

Returns an object that allows to traverse the tree of directories and files.

Exceptions

Exception Description

Exception	Description
System.ArgumentNullException	A `null` reference (`Nothing` in Visual Basic) is passed to a method that does not accept it as a valid argument. This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

System.ArgumentNullException

A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.

This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

Remarks

A directory contents that supports IDirectoryContents2 is needed for browsing into subdirectories. If you only have Microsoft.Extensions.FileProviders.IDirectoryContents but also a Microsoft.Extensions.FileProviders.IFileProvider, you can use OpcLabs.BaseLib.Extensions.FileProviders.Internal.FileSystemNodeTreePositionExtension.Traverse.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

Reference

IDirectoryContents2Extension Class
IDirectoryContents2Extension Members
Overload List

Send Documentation Feedback. Resources: Knowledge Base. Technical support: Online Forums, FAQ.