(Go) SFTP Read Directory Listing

See more SFTP Examples

Demonstrates how to download a directory listing and iterate over the files.

Chilkat Go Downloads Go Package for Windows, MacOS, Linux, Alpine Linux, Solaris

    // This requires the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    // Important: It is helpful to send the contents of the
    // sftp.LastErrorText property when requesting support.

    sftp := chilkat.NewSFtp()

    // Set some timeouts, in milliseconds:
    sftp.SetConnectTimeoutMs(5000)
    sftp.SetIdleTimeoutMs(10000)

    // Connect to the SSH server.  
    // The standard SSH port = 22
    // The hostname may be a hostname or IP address.
    hostname := "www.my-sftp-server.com"
    port := 22
    success := sftp.Connect(hostname,port)
    if success != true {
        fmt.Println(sftp.LastErrorText())
        sftp.DisposeSFtp()
        return
    }

    // Authenticate with the SSH server.  Chilkat SFTP supports
    // both password-based authenication as well as public-key
    // authentication.  This example uses password authenication.
    success = sftp.AuthenticatePw("myLogin","myPassword")
    if success != true {
        fmt.Println(sftp.LastErrorText())
        sftp.DisposeSFtp()
        return
    }

    // After authenticating, the SFTP subsystem must be initialized:
    success = sftp.InitializeSftp()
    if success != true {
        fmt.Println(sftp.LastErrorText())
        sftp.DisposeSFtp()
        return
    }

    // Open a directory on the server...
    // Paths starting with a slash are "absolute", and are relative 
    // to the root of the file system. Names starting with any other 
    // character are relative to the user's default directory (home directory).
    // A path component of ".." refers to the parent directory, 
    // and "." refers to the current directory. 
    handle := sftp.OpenDir(".")
    if sftp.LastMethodSuccess() != true {
        fmt.Println(sftp.LastErrorText())
        sftp.DisposeSFtp()
        return
    }

    // Download the directory listing:
    dirListing := sftp.ReadDir(*handle)
    if sftp.LastMethodSuccess() != true {
        fmt.Println(sftp.LastErrorText())
        sftp.DisposeSFtp()
        return
    }

    // Close the handle for the directory listing.
    success = sftp.CloseHandle(*handle)
    if success != true {
        fmt.Println(sftp.LastErrorText())
        sftp.DisposeSFtp()
        return
    }

    // Iterate over the files.
    i := 0
    n := dirListing.NumFilesAndDirs()
    for i < n {
        fileObj := dirListing.GetFileObject(i)

        fmt.Println(fileObj.Filename())
        fmt.Println(fileObj.FileType())
        fmt.Println("Size in bytes: ", fileObj.Size32())
        fmt.Println("----")

        fileObj.DisposeSFtpFile()

        i = i + 1
    }

    dirListing.DisposeSFtpDir()

    fmt.Println("Success.")

    sftp.DisposeSFtp()