GetStatistics(IDirectoryContents2,Boolean) Method

Computes the directory statistics, such as total number of bytes in directory files, and number of files and subdirectories contained in the directory, optionally recursively.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
Public Overloads Shared Function GetStatistics( _
   ByVal directoryContents2 As IDirectoryContents2, _
   ByVal recursive As Boolean _
) As ValueTuple(Of Long,Long,Long)

'Usage
 
Dim directoryContents2 As IDirectoryContents2
Dim recursive As Boolean
Dim value As ValueTuple(Of Long,Long,Long)
 
value = IDirectoryContents2Extension.GetStatistics(directoryContents2, recursive)

[Extension()]
public static ValueTuple<long,long,long> GetStatistics( 
   IDirectoryContents2 directoryContents2,
   bool recursive
)

[Extension()]
public:
static ValueTuple<int64,int64,int64> GetStatistics( 
   IDirectoryContents2^ directoryContents2,
   bool recursive
)

Parameters

directoryContents2: The directory contents object that will perform the operation.
The value of this parameter cannot be null (Nothing in Visual Basic).
recursive: Determines whether operation will also be performed on subdirectories, recursively.

Return Value

Returns a tuple with total number of byte, total number of files, and total number of directories.

Exceptions

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.IO.IOException	An I/O error has occurred. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.
System.NotSupportedException	An invoked method is not supported at all, or is not supported with the parameters used to create the object.
System.Security.SecurityException	A security error was detected. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.
System.UnauthorizedAccessException	The operating system has denied access because of an I/O error or a specific type of security error. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.

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

Reference

IDirectoryContents2Extension Class
IDirectoryContents2Extension Members
Overload List

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

Missing some example? Ask us for it on our Online Forums! You do not have to own a commercial license in order to use Online Forums, and we reply to every post.