Swift

SFTP Read Text File

See more SFTP Examples

Demonstrates how to open a text file on the SSH server and read text. Swift

func chilkatTest() {
    var success: Bool = false

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

    let sftp = CkoSFtp()!

    // Set some timeouts, in milliseconds:
    sftp.connectTimeoutMs = 5000
    sftp.idleTimeoutMs = 15000

    // Connect to the SSH server.  
    // The standard SSH port = 22
    // The hostname may be a hostname or IP address.
    var hostname: String? = "sftp.example.com"
    var port: Int = 22
    success = sftp.connect(hostname: hostname, port: port)
    if success != true {
        print("\(sftp.lastErrorText!)")
        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(login: "myLogin", password: "myPassword")
    if success != true {
        print("\(sftp.lastErrorText!)")
        return
    }

    // After authenticating, the SFTP subsystem must be initialized:
    success = sftp.initializeSftp()
    if success != true {
        print("\(sftp.lastErrorText!)")
        return
    }

    // Open a file for reading.
    var handle: String?
    handle = sftp.openFile(filename: "myTest.txt", access: "readOnly", createDisp: "openExisting")
    if sftp.lastMethodSuccess != true {
        print("\(sftp.lastErrorText!)")
        return
    }

    // Assume the file we are reading contains the following text:
    // abcdefghijklmnopqrstuvwxyz1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZ
    // (in ANSI format -- i.e. one byte per char).

    // Read 26 bytes:
    var sText: String?
    sText = sftp.readFileText(sftpHandle: handle, numBytes: 26, charset: "ansi")
    if sftp.lastMethodSuccess != true {
        print("\(sftp.lastErrorText!)")
        return
    }

    // Should print "abcdefghijklmnopqrstuvwxyz"
    print("\(sText!)")

    // Read the next 10 bytes.
    sText = sftp.readFileText(sftpHandle: handle, numBytes: 10, charset: "ansi")
    if sftp.lastMethodSuccess != true {
        print("\(sftp.lastErrorText!)")
        return
    }

    // Should print "1234567890"
    print("\(sText!)")

    // Read the next 26 bytes.
    sText = sftp.readFileText(sftpHandle: handle, numBytes: 26, charset: "ansi")
    if sftp.lastMethodSuccess != true {
        print("\(sftp.lastErrorText!)")
        return
    }

    // Should print "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
    print("\(sText!)")

    // Close the file.
    success = sftp.closeHandle(sftpHandle: handle)
    if success != true {
        print("\(sftp.lastErrorText!)")
        return
    }

    print("Success.")

}