OPC Studio User's Guide and Reference
BrowseAll(IDirectoryContents2,Boolean) Method



OpcLabs.BaseLib Assembly > OpcLabs.BaseLib.Extensions.FileProviders Namespace > IDirectoryContents2Extension Class > BrowseAll Method : BrowseAll(IDirectoryContents2,Boolean) Method
The directory contents object that will perform the operation.

The value of this parameter cannot be null (Nothing in Visual Basic).

Specifies whether to include file objects in the returned tree.
Enumerates subdirectories and files in the given directory, recursively, and allowing to specify whether to include file objects.
Syntax
'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Overloads Shared Function BrowseAll( _
   ByVal directoryContents2 As IDirectoryContents2, _
   ByVal includeFiles As Boolean _
) As IEnumerable(Of FileSystemNodeTreePosition)
'Usage
 
Dim directoryContents2 As IDirectoryContents2
Dim includeFiles As Boolean
Dim value As IEnumerable(Of FileSystemNodeTreePosition)
 
value = IDirectoryContents2Extension.BrowseAll(directoryContents2, 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 a sequence of directories and files.

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

The individual elements of the returned value are never null (Nothing in Visual Basic).

Exceptions
ExceptionDescription

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

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

See Also