B4X

SFTP Read Text File

See more SFTP Examples

Demonstrates how to open a text file on the SSH server and read text. 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 = 15000

'  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 reading.
Dim handle As String
handle = sftp.OpenFile("myTest.txt", "readOnly", "openExisting")
If sftp.LastMethodSuccess <> True Then
    Log(sftp.LastErrorText)
    Return
End If


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

'  Read 26 bytes:
Dim sText As String
sText = sftp.ReadFileText(handle, 26, "ansi")
If sftp.LastMethodSuccess <> True Then
    Log(sftp.LastErrorText)
    Return
End If


'  Should print "abcdefghijklmnopqrstuvwxyz";
Log(sText)

'  Read the next 10 bytes.
sText = sftp.ReadFileText(handle, 10, "ansi")
If sftp.LastMethodSuccess <> True Then
    Log(sftp.LastErrorText)
    Return
End If


'  Should print "1234567890";
Log(sText)

'  Read the next 26 bytes.
sText = sftp.ReadFileText(handle, 26, "ansi")
If sftp.LastMethodSuccess <> True Then
    Log(sftp.LastErrorText)
    Return
End If


'  Should print "ABCDEFGHIJKLMNOPQRSTUVWXYZ";
Log(sText)

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


Log("Success.")