Sample code for 30+ languages & platforms
Lianja

SFTP Read Text File

See more SFTP Examples

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

Chilkat Lianja Downloads

Lianja
llSuccess = .F.

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

loSftp = createobject("CkSFtp")

// Set some timeouts, in milliseconds:
loSftp.ConnectTimeoutMs = 5000
loSftp.IdleTimeoutMs = 15000

// Connect to the SSH server.  
// The standard SSH port = 22
// The hostname may be a hostname or IP address.
lcHostname = "sftp.example.com"
lnPort = 22
llSuccess = loSftp.Connect(lcHostname,lnPort)
if (llSuccess <> .T.) then
    ? loSftp.LastErrorText
    release loSftp
    return
endif

// Authenticate with the SSH server.  Chilkat SFTP supports
// both password-based authenication as well as public-key
// authentication.  This example uses password authenication.
llSuccess = loSftp.AuthenticatePw("myLogin","myPassword")
if (llSuccess <> .T.) then
    ? loSftp.LastErrorText
    release loSftp
    return
endif

// After authenticating, the SFTP subsystem must be initialized:
llSuccess = loSftp.InitializeSftp()
if (llSuccess <> .T.) then
    ? loSftp.LastErrorText
    release loSftp
    return
endif

// Open a file for reading.

lcHandle = loSftp.OpenFile("myTest.txt","readOnly","openExisting")
if (loSftp.LastMethodSuccess <> .T.) then
    ? loSftp.LastErrorText
    release loSftp
    return
endif

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

// Read 26 bytes:

lcSText = loSftp.ReadFileText(lcHandle,26,"ansi")
if (loSftp.LastMethodSuccess <> .T.) then
    ? loSftp.LastErrorText
    release loSftp
    return
endif

// Should print "abcdefghijklmnopqrstuvwxyz"
? lcSText

// Read the next 10 bytes.
lcSText = loSftp.ReadFileText(lcHandle,10,"ansi")
if (loSftp.LastMethodSuccess <> .T.) then
    ? loSftp.LastErrorText
    release loSftp
    return
endif

// Should print "1234567890"
? lcSText

// Read the next 26 bytes.
lcSText = loSftp.ReadFileText(lcHandle,26,"ansi")
if (loSftp.LastMethodSuccess <> .T.) then
    ? loSftp.LastErrorText
    release loSftp
    return
endif

// Should print "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
? lcSText

// Close the file.
llSuccess = loSftp.CloseHandle(lcHandle)
if (llSuccess <> .T.) then
    ? loSftp.LastErrorText
    release loSftp
    return
endif

? "Success."


release loSftp