PowerBuilder

SFTP Simplified Download

See more SFTP Examples

Demonstrates how to SFTP download a file by passing a remote filepath to DownloadFileByName. PowerBuilder

integer li_rc
long li_Success
oleobject loo_Sftp
string ls_Hostname
long li_Port
string ls_RemoteFilePath
string ls_LocalFilePath

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 = 15000
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

//  Download the file:

ls_LocalFilePath = "c:/temp/hamlet.xml"
//  Note: The remote filepath may be an absolute filepath,
//  a relative filepath, or simply a filename.  
//  Relative filepaths are always relative to the home directory
//  of the SFTP/SSH user account.  There is no such thing
//  as "current remote directory" in the SFTP protocol. 
//  A filename with no path implies that the file is located
//  in the SFTP user account's home directory.
ls_RemoteFilePath = "subdir1/subdir2/hamlet.xml"
li_Success = loo_Sftp.DownloadFileByName(ls_RemoteFilePath,ls_LocalFilePath)
if li_Success <> 1 then
    Write-Debug loo_Sftp.LastErrorText
    destroy loo_Sftp
    return
end if

Write-Debug "Success."


destroy loo_Sftp