B4X

SFTP Upload from Local Filesystem

See more SFTP Examples

Demonstrates how to upload a file to an SSH server. There are no limitations on file size, and the file is streamed directly from the local filesystem. B4X

Dim success As Boolean = False

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

Dim sftp As ChilkatSFtp
sftp.Initialize("sftp")

'  Set some timeouts, in milliseconds:
sftp.ConnectTimeoutMs = 5000
sftp.IdleTimeoutMs = 10000

'  Connect to the SSH server.  
'  The standard SSH port = 22
'  The hostname may be a hostname or IP address.
Dim hostname As String = "sftp.example.com"
Dim port As Int = 22
success = sftp.Connect(hostname, port)
If success <> True Then
    Log(sftp.LastErrorText)
    Return
End If


'  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 Then
    Log(sftp.LastErrorText)
    Return
End If


'  After authenticating, the SFTP subsystem must be initialized:
success = sftp.InitializeSftp
If success <> True Then
    Log(sftp.LastErrorText)
    Return
End If


'  Open a file for writing on the SSH server.
'  If the file already exists, it is overwritten.
'  (Specify "createNew" instead of "createTruncate" to
'  prevent overwriting existing files.)
Dim handle As String = sftp.OpenFile("hamlet.xml", "writeOnly", "createTruncate")
If sftp.LastMethodSuccess <> True Then
    Log(sftp.LastErrorText)
    Return
End If


'  Upload from the local file to the SSH server.
success = sftp.UploadFile(handle, "c:/temp/hamlet.xml")
If success <> True Then
    Log(sftp.LastErrorText)
    Return
End If


'  -----------------------------------------------------------------------------
'  This is important.  You must close the handle on the server.
'  Otherwise open handles will accumulate on the server until eventually a limit
'  is reached and the server will fail on a call to OpenFile.
'  -----------------------------------------------------------------------------

'  Close the file.
success = sftp.CloseHandle(handle)
If success <> True Then
    Log(sftp.LastErrorText)
    Return
End If


Log("Success.")