SFTP Read Text File to String

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

Download Chilkat SSH / SFTP ActiveX

LOCAL loSftp
LOCAL lnSuccess
LOCAL lnPort
LOCAL lcHostname
LOCAL lcHandle
LOCAL loBFollowLinks
LOCAL loBIsHandle
LOCAL lnNumBytes
LOCAL lcCharset
LOCAL lnOffset32
LOCAL lcFileContents

*  Important: It is helpful to send the contents of the
*  sftp.LastErrorText property when requesting support.

loSftp = CreateObject('Chilkat.SFtp')

*  Any string automatically begins a fully-functional 30-day trial.

lnSuccess = loSftp.UnlockComponent("Anything for 30-day trial")
IF (lnSuccess <> 1) THEN
    =MESSAGEBOX(loSftp.LastErrorText)
    QUIT
ENDIF

*  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 = "www.my-ssh-server.com"
lnPort = 22
lnSuccess = loSftp.Connect(lcHostname,lnPort)
IF (lnSuccess <> 1) THEN
    =MESSAGEBOX(loSftp.LastErrorText)
    QUIT
ENDIF

*  Authenticate with the SSH server.  Chilkat SFTP supports
*  both password-based authenication as well as public-key
*  authentication.  This example uses password authenication.
lnSuccess = loSftp.AuthenticatePw("myLogin","myPassword")
IF (lnSuccess <> 1) THEN
    =MESSAGEBOX(loSftp.LastErrorText)
    QUIT
ENDIF

*  After authenticating, the SFTP subsystem must be initialized:
lnSuccess = loSftp.InitializeSftp()
IF (lnSuccess <> 1) THEN
    =MESSAGEBOX(loSftp.LastErrorText)
    QUIT
ENDIF

*  Open a file on the server:

lcHandle = loSftp.OpenFile("hamlet.xml","readOnly","openExisting")
IF (lcHandle = NULL ) THEN
    =MESSAGEBOX(loSftp.LastErrorText)
    QUIT
ENDIF

*  Get the total size of this file (in bytes)

loBFollowLinks = 0

loBIsHandle = 1

*  bFollowLinks is ignored because we are passing a handle
*  and not a remote filename.
*  There are atlernative methods for handling file sizes
*  greater than 32-bit.  (See the reference documentation.)
lnNumBytes = loSftp.GetFileSize32(lcHandle,llBFollowLinks,llBIsHandle)
IF (lnNumBytes < 0) THEN
    =MESSAGEBOX(loSftp.LastErrorText)
    QUIT
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"

lnOffset32 = 0

lcFileContents = loSftp.ReadFileText32(lcHandle,lnOffset32,lnNumBytes,lcCharset)
IF (lcFileContents = NULL ) THEN
    =MESSAGEBOX(loSftp.LastErrorText)
    QUIT
ELSE
    ? "Received file:"
    ? lcFileContents
ENDIF

*  Close the file.
lnSuccess = loSftp.CloseHandle(lcHandle)
IF (lnSuccess <> 1) THEN
    =MESSAGEBOX(loSftp.LastErrorText)
    QUIT
ENDIF

=MESSAGEBOX("Success.")