PowerBuilder

SFTP Read Text File

See more SFTP Examples

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

integer li_rc
long li_Success
oleobject loo_Sftp
string ls_Hostname
long li_Port
string ls_Handle
string ls_SText

li_Success = 0

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

loo_Sftp = create oleobject
li_rc = loo_Sftp.ConnectToNewObject("Chilkat.SFtp")
if li_rc < 0 then
    destroy loo_Sftp
    MessageBox("Error","Connecting to COM object failed")
    return
end if

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

//  Connect to the SSH server.  
//  The standard SSH port = 22
//  The hostname may be a hostname or IP address.
ls_Hostname = "sftp.example.com"
li_Port = 22
li_Success = loo_Sftp.Connect(ls_Hostname,li_Port)
if li_Success <> 1 then
    Write-Debug loo_Sftp.LastErrorText
    destroy loo_Sftp
    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.
li_Success = loo_Sftp.AuthenticatePw("myLogin","myPassword")
if li_Success <> 1 then
    Write-Debug loo_Sftp.LastErrorText
    destroy loo_Sftp
    return
end if

//  After authenticating, the SFTP subsystem must be initialized:
li_Success = loo_Sftp.InitializeSftp()
if li_Success <> 1 then
    Write-Debug loo_Sftp.LastErrorText
    destroy loo_Sftp
    return
end if

//  Open a file for reading.

ls_Handle = loo_Sftp.OpenFile("myTest.txt","readOnly","openExisting")
if loo_Sftp.LastMethodSuccess <> 1 then
    Write-Debug loo_Sftp.LastErrorText
    destroy loo_Sftp
    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:

ls_SText = loo_Sftp.ReadFileText(ls_Handle,26,"ansi")
if loo_Sftp.LastMethodSuccess <> 1 then
    Write-Debug loo_Sftp.LastErrorText
    destroy loo_Sftp
    return
end if

//  Should print "abcdefghijklmnopqrstuvwxyz";
Write-Debug ls_SText

//  Read the next 10 bytes.
ls_SText = loo_Sftp.ReadFileText(ls_Handle,10,"ansi")
if loo_Sftp.LastMethodSuccess <> 1 then
    Write-Debug loo_Sftp.LastErrorText
    destroy loo_Sftp
    return
end if

//  Should print "1234567890";
Write-Debug ls_SText

//  Read the next 26 bytes.
ls_SText = loo_Sftp.ReadFileText(ls_Handle,26,"ansi")
if loo_Sftp.LastMethodSuccess <> 1 then
    Write-Debug loo_Sftp.LastErrorText
    destroy loo_Sftp
    return
end if

//  Should print "ABCDEFGHIJKLMNOPQRSTUVWXYZ";
Write-Debug ls_SText

//  Close the file.
li_Success = loo_Sftp.CloseHandle(ls_Handle)
if li_Success <> 1 then
    Write-Debug loo_Sftp.LastErrorText
    destroy loo_Sftp
    return
end if

Write-Debug "Success."


destroy loo_Sftp