Contact Info

Crumbtrail » Network Component » How to Use Network Component » SFTP » Visual Basic .NET

Visual Basic .NET SFTP Sample Source Code

Network Component provides an easy-to-use development interface to a variety of IP protocols. By using Network Component, you can very easily create or enhance applications with network features.

Network Component features the following: DNS, FTP, HTTP, HTTPs, ICMP Ping, IP-to-Country, MSN, NTP, RSH, SCP, SFTP, SNMP v1/v2c (Get, GetNext, Set), SNMP Traps, SNMP MIB, SSH, TCP, Telnet, TFTP, UDP, Telnet, Wake-On-LAN and more.

Network Component can be well integrated into any development platform that supports ActiveX objects.

Step 1: Download and install the Network Component

Download Network Component from the ActiveXperts Download Site and start the installation. The installation guides you through the installation process.

Step 2: Create a new Visual Basic .NET Project

Launch Microsoft Visual Studio (for instance 'Microsoft Visual Studio 2008') from the Start menu. Choose 'New' from the 'File' menu and click on 'Project'. In the 'New Project' dialog, select a Visual Studio template (for instance: 'Console Application'). Select a name for the application (for instance: 'DemoApp') and a name for the solution (for instance: 'DemoSolution'). Also, select the directory where you want to store the project (for instance: 'C:\MyProjects):

(Click on the picture to enlarge)

Step 3: Refer to the Network Component Library and create the objects

Now that a new project has been created, you must add a reference to the Network Component in the project to be able to use the the Network Component object. To do so, choose 'Add Reference...' from the 'Project' menu. In the 'Add Reference' dialog that pops up, select the 'COM' tab and select the 'Network Component 4.4 Type Library' as shown in the following picture:

(Click on the picture to enlarge)

Click 'OK' to close the 'Add Reference' dialog.

On top of your code, type the following line to use the Network Component namespace:

Imports AxNetwork

In your Main function, declare and create the following object:

Public objSftp As SFTP

objSftp = New SFTP()

Appendix: Full source code

Imports System.IO
Imports AxNetwork

Module SFtpGetProgram

  Sub Main()
    Dim objSFtp As AxNetwork.SFtp = New AxNetwork.SFtp
    Dim objSFtpFile As AxNetwork.SFtpFile
    Dim strSaveAs As String

    ' A license key is required to unlock this component after the trial period has expired.
    ' Call 'Activate' with a valid license key as its first parameter. Second parameter determines whether to save the license key permanently 
    ' to the registry (True, so you need to call Activate only once), or not to store the key permanently (False, so you need to call Activate
    ' every time the component is created). For details, see manual, chapter "Product Activation".
    ' objSFtp.Activate("XXXXX-XXXXX-XXXXX", False)

    ' Display component information
    Console.WriteLine("ActiveXperts Network Component {0}{1}Build: {2}{3}Module: {4}{5}License Status: {6}{7}License Key: {8}{9}", objSFtp.Version, Environment.NewLine, objSFtp.Build, Environment.NewLine, objSFtp.Module, Environment.NewLine, objSFtp.LicenseStatus, Environment.NewLine, objSFtp.LicenseKey, Environment.NewLine)

    ' Set Logfile (optional, for debugging purposes)
    objSFtp.LogFile = Path.GetTempPath() + "SFtp.log"
    Console.WriteLine("Log file used: {0}{1}", objSFtp.LogFile, Environment.NewLine)

    ' Connect
    objSFtp.Host = ""
    objSFtp.Port = 22
    objSFtp.UserName = "demo"
    objSFtp.Password = "demo"
    objSFtp.AcceptHostKey = True        ' Automatically accept and store the host key if it is changed or unknown
    '  objSftp.PrivateKeyFile = "C:\keyfile.ppk";  ' a private key file can be used instead of a password
    Console.WriteLine("Connect, result: " & objSFtp.LastError.ToString() & " (" & objSFtp.GetErrorDescription(objSFtp.LastError) & ")")
    If (objSFtp.ProtocolError <> "") Then
        Console.WriteLine("ProtocolError: " & objSFtp.ProtocolError)
    End If
    If (objSFtp.LastError = 0) Then

        ' Change directory
        Console.WriteLine("ChangeDir, result: " & objSFtp.LastError.ToString() & " (" & objSFtp.GetErrorDescription(objSFtp.LastError) & ")")
        If (objSFtp.LastError = 0) Then

            ' Iterate over all files
            objSFtpFile = objSFtp.FindFirstFile(".")
            Console.WriteLine("FindFirstFile, result: " & objSFtp.LastError.ToString() & " (" & objSFtp.GetErrorDescription(objSFtp.LastError) & ")")
            While (objSFtp.LastError = 0)

                Console.WriteLine("Name: " & objSFtpFile.Name)
                Console.WriteLine("   IsDirectory: " & objSFtpFile.IsDirectory)
                Console.WriteLine("   Size (bytes): " & objSFtpFile.SizeBytes)
                Console.WriteLine("   Creation date (seconds): " & objSFtpFile.DateSeconds)
                Console.WriteLine("   Creation date: " & objSFtpFile.Date)

                If (objSFtpFile.IsDirectory = 0) Then
                    ' To save the file, call the GetFile function. 
                    strSaveAs = "C:\temp\" & objSFtpFile.Name
                    objSFtp.GetFile(objSFtpFile.Name, strSaveAs)
                    Console.WriteLine("GetFile, result: " & objSFtp.LastError.ToString() & " (" & objSFtp.GetErrorDescription(objSFtp.LastError) & ")")

                    ' To delete a file, call the DeleteFile function. 
                    Console.WriteLine("DeleteFile, result: " & objSFtp.LastError.ToString() & " (" & objSFtp.GetErrorDescription(objSFtp.LastError) & ")")
                End If

                objSFtpFile = objSFtp.FindNextFile()
                Console.WriteLine("FindNextFile, result: " & objSFtp.LastError.ToString() & " (" & objSFtp.GetErrorDescription(objSFtp.LastError) & ")")
            End While

            Console.WriteLine("Disconnect, result: " & objSFtp.LastError.ToString() & " (" & objSFtp.GetErrorDescription(objSFtp.LastError) & ")")
        End If
    End If

    System.Threading.Thread.Sleep(5000) ' Sleep for 5 seconds before exit		
  End Sub

End Module

You can download the complete sample on our FTP site There are many other working Network Component scripts on our site and shipped with the product.

NOTE: Demo Projects are created with Microsoft Visual Studio 2008

The Network Component project ships with a set of Microsoft Visual Studio .NET samples, including samples for Microsoft Visual C# .NET. The projects are created with Microsoft Visual Studio 2008.

Users with a later version of Microsoft Visual Studio can open such a project. The Visual Studio Conversion Wizard will guide you through the process of converting the project to the version used.