QuickOPC 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.
Specifies whether to include file objects in the returned tree.
Enumerates subdirectories and files in the given directory, recursively.
Syntax
'Declaration
 
<ExtensionAttribute()>
<ElementsNotNullAttribute()>
<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)
[Extension()]
[ElementsNotNull()]
[NotNull()]
public static IEnumerable<FileSystemNodeTreePosition> BrowseAll( 
   IDirectoryContents2 directoryContents2,
   bool includeFiles
)
[Extension()]
[ElementsNotNull()]
[NotNull()]
public:
static IEnumerable<FileSystemNodeTreePosition^>^ BrowseAll( 
   IDirectoryContents2^ directoryContents2,
   bool includeFiles
) 

Parameters

directoryContents2
The directory contents object that will perform the operation.
includeFiles
Specifies whether to include file objects in the returned tree.

Return Value

Returns a sequence of directories and files.
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.

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