(Lianja) SFTP Read Text File to String

Demonstrates how to download a text file from an SSH server directly into a string variable.

Chilkat Lianja Extension Download Chilkat Lianja Extension

// 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 on the server:

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

// Get the total size of this file (in bytes)
llBFollowLinks = .F.
llBIsHandle = .T.

// bFollowLinks is ignored because we are passing a handle
// and not a remote filename.
// There are alternative methods for handling file sizes
// greater than 32-bit.  (See the reference documentation.)
lnNumBytes = loSftp.GetFileSize32(lcHandle,llBFollowLinks,llBIsHandle)
if (lnNumBytes < 0) then
    ? loSftp.LastErrorText
    release loSftp
    return
endif

// The charset indicates the character encoding of the text
// file on the SSH server.   Setting the charset correctly
// allows the Chilkat SFTP component to correctly interpret
// the bytes that represent the characters.

lcCharset = "ansi"

lcFileContents = loSftp.ReadFileText(lcHandle,lnNumBytes,lcCharset)
if (loSftp.LastMethodSuccess <> .T.) then
    ? loSftp.LastErrorText
    release loSftp
    return
else
    ? "Received file:"
    ? lcFileContents
endif

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

? "Success."


release loSftp