PureBasic

SFTP Resume Upload

See more SFTP Examples

Demonstrates how to resume an SFTP upload to an SSH server. The ResumeUploadFileByName method checks the size of the file on the remote server and begins uploading from the appropriate position in the local file. PureBasic

IncludeFile "CkSFtp.pb"

Procedure ChilkatExample()

    success.i = 0

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

    sftp.i = CkSFtp::ckCreate()
    If sftp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Set some timeouts, in milliseconds:
    CkSFtp::setCkConnectTimeoutMs(sftp, 5000)
    CkSFtp::setCkIdleTimeoutMs(sftp, 10000)

    ; Connect to the SSH server.  
    ; The standard SSH port = 22
    ; The hostname may be a hostname or IP address.
    hostname.s = "sftp.example.com"
    port.i = 22
    success = CkSFtp::ckConnect(sftp,hostname,port)
    If success <> 1
        Debug CkSFtp::ckLastErrorText(sftp)
        CkSFtp::ckDispose(sftp)
        ProcedureReturn
    EndIf

    ; Authenticate with the SSH server.  Chilkat SFTP supports
    ; both password-based authenication as well as public-key
    ; authentication.  This example uses password authenication.
    success = CkSFtp::ckAuthenticatePw(sftp,"myLogin","myPassword")
    If success <> 1
        Debug CkSFtp::ckLastErrorText(sftp)
        CkSFtp::ckDispose(sftp)
        ProcedureReturn
    EndIf

    ; After authenticating, the SFTP subsystem must be initialized:
    success = CkSFtp::ckInitializeSftp(sftp)
    If success <> 1
        Debug CkSFtp::ckLastErrorText(sftp)
        CkSFtp::ckDispose(sftp)
        ProcedureReturn
    EndIf

    ; Upload from the local file to the SSH server.
    ; Important -- the remote filepath is the 1st argument,
    ; the local filepath is the 2nd argument;
    remoteFilePath.s = "hamlet.xml"
    localFilePath.s = "c:/temp/hamlet.xml"

    ; The ResumeUploadFileByName method first gets the size
    ; of the partial file on the server and then begins uploading
    ; from the appropriate point in the local file.
    ; If the remote file does not exist or is 0-length, this
    ; method is equivalent to UploadFileByName.
    ; If the remote file is already equal to or larger in size
    ; than the local file, then nothing more is uploaded.
    success = CkSFtp::ckResumeUploadFileByName(sftp,remoteFilePath,localFilePath)
    If success <> 1
        Debug CkSFtp::ckLastErrorText(sftp)
        CkSFtp::ckDispose(sftp)
        ProcedureReturn
    EndIf

    Debug "Success."


    CkSFtp::ckDispose(sftp)


    ProcedureReturn
EndProcedure