Chilkat Examples

ChilkatHOMEAndroid™Classic ASPCC++C#Mono C#.NET Core C#C# UWP/WinRTDataFlexDelphi ActiveXDelphi DLLVisual FoxProJavaLianjaMFCObjective-CPerlPHP ActiveXPHP ExtensionPowerBuilderPowerShellPureBasicCkPythonChilkat2-PythonRubySQL ServerSwift 2Swift 3/4TclUnicode CUnicode C++Visual Basic 6.0VB.NETVB.NET UWP/WinRTVBScriptXojo PluginNode.jsExcelGo

PowerBuilder Examples

Web API Categories

ASN.1
Amazon Glacier
Amazon S3
Amazon S3 (new)
Amazon SES
Amazon SNS
Amazon SQS
Async
Azure Cloud Storage
Azure Service Bus
Base64
Bounced Email
Box
CAdES
CSR
CSV
Certificates
Compression
DKIM / DomainKey
DSA
Diffie-Hellman
Digital Signatures
Dropbox
Dynamics CRM
ECC
Email Object
Encryption
FTP
FileAccess
Firebase
GMail REST API
Geolocation
Google APIs
Google Calendar
Google Cloud Storage
Google Drive
Google Photos
Google Sheets
Google Tasks
Gzip
HTML-to-XML/Text

HTTP
HTTP Misc
IMAP
JSON
JSON Web Encryption (JWE)
JSON Web Signatures (JWS)
JSON Web Token (JWT)
Java KeyStore (JKS)
MHT / HTML Email
MIME
Microsoft Graph
NTLM
OAuth1
OAuth2
OneDrive
OpenSSL
Outlook
PEM
PFX/P12
POP3
PRNG
REST
REST Misc
RSA Encryption
SCP
SFTP
SMTP
SSH
SSH Key
SSH Tunnel
SharePoint
Socket/SSL/TLS
Spider
Stream
Tar Archive
Upload
WebSocket
XAdES
XML
XML Digital Signatures
XMP
Zip
curl

 

 

 

(PowerBuilder) Async SFTP Progress Info

Demonstrates checking for progress info updates when running a task asynchronously. This example demonstrates an SFTP download.

Chilkat ActiveX Downloads

ActiveX for 32-bit and 64-bit Windows

integer li_rc
oleobject loo_ChilkatGlob
integer li_Success
oleobject loo_Sftp
string ls_Hostname
integer li_Port
string ls_LocalFilePath
string ls_RemoteFilePath
oleobject loo_Task
integer li_CurPctDone
string ls_Name
string ls_Value

// All Chilkat classes can be unlocked at once at the beginning of a program
// by calling UnlockBundle.  It requires a Bundle unlock code.
loo_ChilkatGlob = create oleobject
li_rc = loo_ChilkatGlob.ConnectToNewObject("Chilkat_9_5_0.Global")
if li_rc < 0 then
    destroy loo_ChilkatGlob
    MessageBox("Error","Connecting to COM object failed")
    return
end if
li_Success = loo_ChilkatGlob.UnlockBundle("Anything for 30-day trial.")
if li_Success <> 1 then
    Write-Debug loo_ChilkatGlob.LastErrorText
    destroy loo_ChilkatGlob
    return
end if

loo_Sftp = create oleobject
li_rc = loo_Sftp.ConnectToNewObject("Chilkat_9_5_0.SFtp")

// 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 = "www.my-ssh-server.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_ChilkatGlob
    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_ChilkatGlob
    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_ChilkatGlob
    destroy loo_Sftp
    return
end if

// --------------------
// Download a file
// --------------------
ls_LocalFilePath = "c:/temp/hamlet.xml"
ls_RemoteFilePath = "subdir1/subdir2/hamlet.xml"

// Call the async version of the DownloadFileByName method to return a task object.
// The task object is loaded, but is in the Inert state -- meaning it is
// not yet scheduled to run on Chilkat's background thread pool.
loo_Task = loo_Sftp.DownloadFileByNameAsync(ls_RemoteFilePath,ls_LocalFilePath)
if loo_Sftp.LastMethodSuccess = 0 then
    Write-Debug loo_Sftp.LastErrorText
    destroy loo_ChilkatGlob
    destroy loo_Sftp
    return
end if

// Before starting the task, tell it to keep an in-memory log of what would've been
// ProgressInfo callbacks.
loo_Task.KeepProgressLog = 1

// Schedule the task for running on the thread pool.  This changes the task's state
// from Inert to Live.
li_Success = loo_Task.Run()
if li_Success <> 1 then
    Write-Debug loo_Task.LastErrorText
    destroy loo_Task
    destroy loo_ChilkatGlob
    destroy loo_Sftp
    return
end if

// The application is now free to do anything else
// while the file is being downloaded.

// For this example, we'll simply sleep and periodically
// check to see if the download is finished, and report the progress
// along the way.
li_CurPctDone = 0

do while loo_Task.Finished <> 1

    if loo_Task.PercentDone <> li_CurPctDone then
        li_CurPctDone = loo_Task.PercentDone
        Write-Debug string(li_CurPctDone) + " percent done"
    end if

    // Check the progress info log.
    // Emit any log entries..
    do while (loo_Task.ProgressLogSize > 0)
        // Get the 1st entry, emit it, and then remove it..
        ls_Name = loo_Task.ProgressInfoName(0)
        ls_Value = loo_Task.ProgressInfoValue(0)

        // Entries reporting the received byte count will have the name "RcvByteCount"
        // Entries reporting the current bytes-per-second will have the name "RcvBytesPerSec"

        Write-Debug ls_Name + ": " + ls_Value
        loo_Task.RemoveProgressInfo(0)
    loop

    // Sleep 100 ms.
    loo_Task.SleepMs(100)

loop

// Just in case there are any remaining entries...
do while (loo_Task.ProgressLogSize > 0)
    // Get the 1st entry, emit it, and then remove it..
    ls_Name = loo_Task.ProgressInfoName(0)
    ls_Value = loo_Task.ProgressInfoValue(0)
    Write-Debug ls_Name + ": " + ls_Value
    loo_Task.RemoveProgressInfo(0)
loop

// A finished task could be one that was canceled, aborted, or truly finished.  

// If the task was "canceled", it was canceled prior to actually starting.  This could
// happen if the task was canceled while waiting in a thread pool queue to be scheduled by Chilkat's
// background thread pool scheduler.  

// If the task was "aborted", it indicates that it was canceled while running in a background thread.  
// The ResultErrorText will likely indicate that the task was aborted.

// If the task "completed", then it ran to completion, but the actual success/failure of the method
// is determined by the result obtained via a GetResult* method.  (A "completed" task will
// have a StatusInt equal to 7.   If the task finished, but was not completed, then it must've
// been aborted or canceled:
if loo_Task.StatusInt <> 7 then
    Write-Debug "Task did not complete."
    Write-Debug "task status: " + loo_Task.Status
    destroy loo_Task
    destroy loo_ChilkatGlob
    destroy loo_Sftp
    return
end if

// The DownloadFileByName method returns a boolean.  Therefore, after the task is finished,
// we can get the boolean result by calling GetResultBool.  This is the return value had
// we called DownloadFileByName synchronously.
li_Success = loo_Task.GetResultBool()
if li_Success <> 1 then
    // The task's ResultErrorText contains what would have been in the LastErrorText property had
    // the DownloadFileByName method been called synchronously.
    Write-Debug loo_Task.ResultErrorText
else
    Write-Debug "File downloaded asynchronously."
end if

destroy loo_Task


destroy loo_ChilkatGlob
destroy loo_Sftp

 

© 2000-2019 Chilkat Software, Inc. All Rights Reserved.