BrowseTree(IDirectoryContents2,Boolean) Method

Browses a tree of subdirectories and (optionally) files in the given directory, recursively, and allowing to specify whether to include file objects.

Syntax

Visual Basic
C#
C++/CLI

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

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

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

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

Parameters

directoryContents2: The directory contents object that will perform the operation.
The value of this parameter cannot be null (Nothing in Visual Basic).
includeFiles: Specifies whether to include file objects in the returned tree.

Return Value

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

This method never returns null (Nothing in Visual Basic).

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.

This is an extension method (info: C#, VB.NET). In languages that have support for extensions methods (such as C# and VB.NET), you can use the extension method as if it were a regular method on the object that is its first parameter. In other languages (such as with Python.NET), you will call the extension as a static method, and pass it the object on which it acts as its first parameter.

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

Documentation Home, Send Documentation Feedback. Technical Support