Welcome!
Licensing and How to Order
Installation Instruction
Overview and how to use Ultimate Ftp in Visual Studio
Connect to an FTP server
Authentication
Upload and download a single file
Wildcard masks and search criterion
Upload and download multiple files
Manage a single remote file
Manage multiple remote files and directories
Upload and download a directory
Directory synchronization
Manage a remote directory
Unified API for SFTP and FTP
Show the progress while transferring data
Transfer queue
Cancel an operation
Server-to-server transfers (FXP)
Other FTP features
Using FtpWebRequest
Control bandwidth and speed optimization
Events
Logging
Determine local PC and server time difference
Use asynchronous methods
Use path utility methods
Handle errors
Class Reference
- ComponentPro
- ComponentPro.Collections
- ComponentPro.Compression
- ComponentPro.Diagnostics
- ComponentPro.IO
- ComponentPro.IO.Synchronization
- ComponentPro.Net
- ComponentPro.Security
- ComponentPro.Security.Authentication
- ComponentPro.Security.Certificates
- ComponentPro.Security.Cryptography
- ComponentPro.Security.Cryptography.Pkcs

ComponentPro UltimateFtp

GetDirectorySizeCompleted Event

Class Reference > ComponentPro.IO Namespace > FileSystem Class > GetDirectorySizeCompleted Event

Occurs when an asynchronous GetDirectorySizeAsync operation completes.

Syntax

public event ExtendedAsyncCompletedEventHandler<TResult> GetDirectorySizeCompleted

Public Event GetDirectorySizeCompleted ExtendedAsyncCompletedEventHandler(Of TResult)

public:
 event ExtendedAsyncCompletedEventHandler<TResult>^ GetDirectorySizeCompleted

Examples

FTP Examples

Shows how to use GetDirectorySizeAsync method to asynchronously calculate total size of a directory (Task-based approach).

Copy Code

VB.NET

using System;
using ComponentPro.IO;
using ComponentPro.Net;
using ComponentPro;

...

static async void Main()
{
    // Create a new class instance. 
    Ftp client = new Ftp();

    // Connect to the FTP server. 
    client.Connect("myserver");

    // Authenticate. 
    client.Authenticate("userName", "password");

    // ... 
 
    // Calculate total size of an entire directory. 
    long totalSize = await client.GetDirectorySizeAsync("/myfolder", true, new NameSearchCondition("*.*"));

    // ... 
 
    Console.WriteLine("Calculate total size for all files: " + FormatSize(totalSize));

    // Disconnect. 
    client.Disconnect();
}

/// <summary> 
/// Returns a formatted file size in bytes, kbytes, or mbytes. 
/// </summary> 
/// <param name="size">The input file size.</param> 
/// <returns>The formatted file size.</returns> 
public static string FormatSize(long size)
{
    if (size < 1024)
        return size + " B";
    if (size < 1024 * 1024)
        return string.Format("{0:#.#} KB", size / 1024.0f);
    return size < 1024 * 1024 * 1024 ? string.Format("{0:#.#} MB", size / 1024.0f / 1024.0f) : string.Format("{0:#.#} GB", size / 1024.0f / 1024.0f / 1024.0f);
}

Imports ComponentPro.IO
Imports ComponentPro.Net
Imports ComponentPro

...

Shared Async Sub Main()
    ' Create a new class instance. 
    Dim client As New Ftp()

    ' Connect to the FTP server. 
    client.Connect("myserver")

    ' Authenticate. 
    client.Authenticate("userName", "password")

    ' ... 
 
    ' Calculate total size of an entire directory. 
    Dim totalSize As Long = Await client.GetDirectorySizeAsync("/myfolder", True, New NameSearchCondition("*.*"))

    ' ... 
 
    Console.WriteLine("Calculate total size for all files: " & FormatSize(totalSize))

    ' Disconnect. 
    client.Disconnect()
End Sub 
 
''' <summary> 
''' Returns a formatted file size in bytes, kbytes, or mbytes. 
''' </summary> 
''' <param name="size">The input file size.</param> 
''' <returns>The formatted file size.</returns> 
Public Shared Function FormatSize(ByVal size As Long) As String 
    If size < 1024 Then 
        Return size & " B" 
    End If 
    If size < 1024 * 1024 Then 
        Return String.Format("{0:#.#} KB", size / 1024.0F)
    End If 
    If size < 1024 * 1024 * 1024 Then 
        Return String.Format("{0:#.#} MB", size / 1024.0F / 1024.0F)
    Else 
        Return String.Format("{0:#.#} GB", size / 1024.0F / 1024.0F / 1024.0F)
    End If 
End Function

Shows how to use GetDirectorySizeAsync method to asynchronously calculate total size of a directory (Event-based approach).

Copy Code

VB.NET

using System;
using System.ComponentModel;
using ComponentPro.IO;
using ComponentPro.Net;
using ComponentPro;

...

static void Main()
{
    // Create a new class instance. 
    Ftp client = new Ftp();

    // Connect to the FTP server. 
    client.Connect("myserver");

    // Authenticate. 
    client.Authenticate("userName", "password");

    // ... 
 
    // Register an event handler. 
    client.GetDirectorySizeCompleted += client_GetDirectorySizeCompleted;

    // Calculate total size of an entire directory. 
    client.GetDirectorySizeAsync("/myfolder", true, new NameSearchCondition("*.*"));

    // ... 
 
    // Disconnect. 
    client.Disconnect();
}

static void client_GetDirectorySizeCompleted(object sender, ExtendedAsyncCompletedEventArgs<long> e)
{
    // Ftp client = (Ftp)sender; 
    if (e.Error != null)
    {
        Console.WriteLine("Error: " + e.Error.ToString());
    }
    else 
    {
        long totalSize = e.Result;
        Console.WriteLine("Calculate total size for all files: " + FormatSize(totalSize));
    }       
}

/// <summary> 
/// Returns a formatted file size in bytes, kbytes, or mbytes. 
/// </summary> 
/// <param name="size">The input file size.</param> 
/// <returns>The formatted file size.</returns> 
public static string FormatSize(long size)
{
    if (size < 1024)
        return size + " B";
    if (size < 1024 * 1024)
        return string.Format("{0:#.#} KB", size / 1024.0f);
    return size < 1024 * 1024 * 1024 ? string.Format("{0:#.#} MB", size / 1024.0f / 1024.0f) : string.Format("{0:#.#} GB", size / 1024.0f / 1024.0f / 1024.0f);
}

Imports System.ComponentModel
Imports ComponentPro.IO
Imports ComponentPro.Net
Imports ComponentPro

...

Shared Sub Main()
    ' Create a new class instance. 
    Dim client As New Ftp()

    ' Connect to the FTP server. 
    client.Connect("myserver")

    ' Authenticate. 
    client.Authenticate("userName", "password")

    ' ... 
 
    ' Register an event handler. 
    AddHandler client.GetDirectorySizeCompleted, AddressOf client_GetDirectorySizeCompleted

    ' Calculate total size of an entire directory. 
    client.GetDirectorySizeAsync("/myfolder", True, New NameSearchCondition("*.*"))

    ' ... 
 
    ' Disconnect. 
    client.Disconnect()
End Sub 
 
Private Shared Sub client_GetDirectorySizeCompleted(ByVal sender As Object, ByVal e As ExtendedAsyncCompletedEventArgs(Of Long))
    ' Ftp client = (Ftp)sender; 
    If e.Error IsNot Nothing Then 
        Console.WriteLine("Error: " & e.Error.ToString())
    Else 
        Dim totalSize As Long = e.Result
        Console.WriteLine("Calculate total size for all files: " & FormatSize(totalSize))
    End If 
End Sub 
 
''' <summary> 
''' Returns a formatted file size in bytes, kbytes, or mbytes. 
''' </summary> 
''' <param name="size">The input file size.</param> 
''' <returns>The formatted file size.</returns> 
Public Shared Function FormatSize(ByVal size As Long) As String 
    If size < 1024 Then 
        Return size & " B" 
    End If 
    If size < 1024 * 1024 Then 
        Return String.Format("{0:#.#} KB", size / 1024.0F)
    End If 
    If size < 1024 * 1024 * 1024 Then 
        Return String.Format("{0:#.#} MB", size / 1024.0F / 1024.0F)
    Else 
        Return String.Format("{0:#.#} GB", size / 1024.0F / 1024.0F / 1024.0F)
    End If 
End Function

SFTP Examples

Shows how to use GetDirectorySizeAsync method to asynchronously calculate total size of a directory (Task-based approach).

Copy Code

VB.NET

using System;
using ComponentPro.IO;
using ComponentPro.Net;
using ComponentPro;

...

static async void Main()
{
    // Create a new class instance. 
    Sftp client = new Sftp();

    // Connect to the SFTP server. 
    client.Connect("myserver");

    // Authenticate. 
    client.Authenticate("userName", "password");

    // ... 
 
    // Calculate total size of an entire directory. 
    long totalSize = await client.GetDirectorySizeAsync("/myfolder", true, new NameSearchCondition("*.*"));

    // ... 
 
    Console.WriteLine("Calculate total size for all files: " + FormatSize(totalSize));

    // Disconnect. 
    client.Disconnect();
}

/// <summary> 
/// Returns a formatted file size in bytes, kbytes, or mbytes. 
/// </summary> 
/// <param name="size">The input file size.</param> 
/// <returns>The formatted file size.</returns> 
public static string FormatSize(long size)
{
    if (size < 1024)
        return size + " B";
    if (size < 1024 * 1024)
        return string.Format("{0:#.#} KB", size / 1024.0f);
    return size < 1024 * 1024 * 1024 ? string.Format("{0:#.#} MB", size / 1024.0f / 1024.0f) : string.Format("{0:#.#} GB", size / 1024.0f / 1024.0f / 1024.0f);
}

Imports ComponentPro.IO
Imports ComponentPro.Net
Imports ComponentPro

...

Shared Async Sub Main()
    ' Create a new class instance. 
    Dim client As New Sftp()

    ' Connect to the SFTP server. 
    client.Connect("myserver")

    ' Authenticate. 
    client.Authenticate("userName", "password")

    ' ... 
 
    ' Calculate total size of an entire directory. 
    Dim totalSize As Long = Await client.GetDirectorySizeAsync("/myfolder", True, New NameSearchCondition("*.*"))

    ' ... 
 
    Console.WriteLine("Calculate total size for all files: " & FormatSize(totalSize))

    ' Disconnect. 
    client.Disconnect()
End Sub 
 
''' <summary> 
''' Returns a formatted file size in bytes, kbytes, or mbytes. 
''' </summary> 
''' <param name="size">The input file size.</param> 
''' <returns>The formatted file size.</returns> 
Public Shared Function FormatSize(ByVal size As Long) As String 
    If size < 1024 Then 
        Return size & " B" 
    End If 
    If size < 1024 * 1024 Then 
        Return String.Format("{0:#.#} KB", size / 1024.0F)
    End If 
    If size < 1024 * 1024 * 1024 Then 
        Return String.Format("{0:#.#} MB", size / 1024.0F / 1024.0F)
    Else 
        Return String.Format("{0:#.#} GB", size / 1024.0F / 1024.0F / 1024.0F)
    End If 
End Function

Shows how to use GetDirectorySizeAsync method to asynchronously calculate total size of a directory (Event-based approach).

Copy Code

VB.NET

using System;
using System.ComponentModel;
using ComponentPro.IO;
using ComponentPro.Net;
using ComponentPro;

...

static void Main()
{
    // Create a new class instance. 
    Sftp client = new Sftp();

    // Connect to the SFTP server. 
    client.Connect("myserver");

    // Authenticate. 
    client.Authenticate("userName", "password");

    // ... 
 
    // Register an event handler. 
    client.GetDirectorySizeCompleted += client_GetDirectorySizeCompleted;

    // Calculate total size of an entire directory. 
    client.GetDirectorySizeAsync("/myfolder", true, new NameSearchCondition("*.*"));

    // ... 
 
    // Disconnect. 
    client.Disconnect();
}

static void client_GetDirectorySizeCompleted(object sender, ExtendedAsyncCompletedEventArgs<long> e)
{
    // Sftp client = (Sftp)sender; 
    if (e.Error != null)
    {
        Console.WriteLine("Error: " + e.Error.ToString());
    }
    else 
    {
        long totalSize = e.Result;
        Console.WriteLine("Calculate total size for all files: " + FormatSize(totalSize));
    }       
}

/// <summary> 
/// Returns a formatted file size in bytes, kbytes, or mbytes. 
/// </summary> 
/// <param name="size">The input file size.</param> 
/// <returns>The formatted file size.</returns> 
public static string FormatSize(long size)
{
    if (size < 1024)
        return size + " B";
    if (size < 1024 * 1024)
        return string.Format("{0:#.#} KB", size / 1024.0f);
    return size < 1024 * 1024 * 1024 ? string.Format("{0:#.#} MB", size / 1024.0f / 1024.0f) : string.Format("{0:#.#} GB", size / 1024.0f / 1024.0f / 1024.0f);
}

Imports System.ComponentModel
Imports ComponentPro.IO
Imports ComponentPro.Net
Imports ComponentPro

...

Shared Sub Main()
    ' Create a new class instance. 
    Dim client As New Sftp()

    ' Connect to the SFTP server. 
    client.Connect("myserver")

    ' Authenticate. 
    client.Authenticate("userName", "password")

    ' ... 
 
    ' Register an event handler. 
    AddHandler client.GetDirectorySizeCompleted, AddressOf client_GetDirectorySizeCompleted

    ' Calculate total size of an entire directory. 
    client.GetDirectorySizeAsync("/myfolder", True, New NameSearchCondition("*.*"))

    ' ... 
 
    ' Disconnect. 
    client.Disconnect()
End Sub 
 
Private Shared Sub client_GetDirectorySizeCompleted(ByVal sender As Object, ByVal e As ExtendedAsyncCompletedEventArgs(Of Long))
    ' Sftp client = (Sftp)sender; 
    If e.Error IsNot Nothing Then 
        Console.WriteLine("Error: " & e.Error.ToString())
    Else 
        Dim totalSize As Long = e.Result
        Console.WriteLine("Calculate total size for all files: " & FormatSize(totalSize))
    End If 
End Sub 
 
''' <summary> 
''' Returns a formatted file size in bytes, kbytes, or mbytes. 
''' </summary> 
''' <param name="size">The input file size.</param> 
''' <returns>The formatted file size.</returns> 
Public Shared Function FormatSize(ByVal size As Long) As String 
    If size < 1024 Then 
        Return size & " B" 
    End If 
    If size < 1024 * 1024 Then 
        Return String.Format("{0:#.#} KB", size / 1024.0F)
    End If 
    If size < 1024 * 1024 * 1024 Then 
        Return String.Format("{0:#.#} MB", size / 1024.0F / 1024.0F)
    Else 
        Return String.Format("{0:#.#} GB", size / 1024.0F / 1024.0F / 1024.0F)
    End If 
End Function

Framework

.NET Compact Framework

Supported version: 2.0, 3.5, and 3.9
Assembly: ComponentPro.FileSystem.CF (in ComponentPro.FileSystem.CF.dll)

.NET Framework

Supported version: 2.0, 3.0, 3.5, 4.0, 4.5.x, 4.6.x and later
Assembly: ComponentPro.FileSystem (in ComponentPro.FileSystem.dll)

Portable Class Library for Windows Phone 8.1 and Windows 8.1 Store Apps

Supported version: 4.6.x and later
Assembly: ComponentPro.FileSystem.WinPcl (in ComponentPro.FileSystem.WinPcl.dll)

Universal Windows Platform (includes Windows 10 Mobile, Windows 10 Store Apps and Windows 10 IoT)

Supported version: 4.6.x and later
Assembly: ComponentPro.FileSystem.Uwp (in ComponentPro.FileSystem.Uwp.dll)

Xamarin Android

Supported version: 2.3 and later
Assembly: ComponentPro.FileSystem.Android (in ComponentPro.FileSystem.Android.dll)

Xamarin Mac

Supported version: 2.0.x and later
Assembly: ComponentPro.FileSystem.Mac (in ComponentPro.FileSystem.Mac.dll)

Xamarin iOS

Supported version: 5.1.x and later
Assembly: ComponentPro.FileSystem.iOS (in ComponentPro.FileSystem.iOS.dll)

GetDirectorySizeCompleted Event

Syntax

Examples

FTP Examples

SFTP Examples

Framework

.NET Compact Framework

.NET Framework

Portable Class Library for Windows Phone 8.1 and Windows 8.1 Store Apps

Universal Windows Platform (includes Windows 10 Mobile, Windows 10 Store Apps and Windows 10 IoT)

Xamarin Android

Xamarin Mac

Xamarin iOS

See Also

Reference