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

SQL Server Examples

ASN.1
Amazon S3
Amazon S3 (new)
Amazon SES
Amazon SNS
Amazon SQS
Async
Azure Cloud Storage
Azure Service Bus
Base64
Bounced Email
Box
CSR
CSV
Certificates
Compression
DKIM / DomainKey
DSA
Diffie-Hellman
Digital Signatures
Dropbox
Dynamics CRM
ECC
Email Object
Encryption
FTP
Facebook
FileAccess
Firebase
GMail REST API
GeoOp
Google APIs
Google Calendar
Google Cloud Storage
Google Drive
Google Sheets
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)
Jira
MHT / HTML Email
MIME
Microsoft Graph
NTLM
OAuth1
OAuth2
OneDrive
OpenSSL
Outlook
PEM
PFX/P12
POP3
PRNG
PayPal
Peoplevox
QuickBooks
REST
REST Misc
RSA Encryption
SCP
SFTP
SMTP
SSH
SSH Key
SSH Tunnel
SharePoint
Shopify
Socket/SSL/TLS
Spider
Stream
Stripe
SugarCRM
Tar Archive
Twitter
Upload
VoiceBase
Walmart
WebSocket
XAdES
XML
XML Digital Signatures
XMP
Xero
Zip
curl
eBay

 

 

 

(SQL Server) 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

CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    DECLARE @sTmp0 nvarchar(4000)
    --  All Chilkat classes can be unlocked at once at the beginning of a program
    --  by calling UnlockBundle.  It requires a Bundle unlock code.
    DECLARE @chilkatGlob int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Global', @chilkatGlob OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int
    EXEC sp_OAMethod @chilkatGlob, 'UnlockBundle', @success OUT, 'Anything for 30-day trial.'
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @chilkatGlob, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @chilkatGlob
        RETURN
      END

    DECLARE @sftp int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.SFtp', @sftp OUT

    --  Set some timeouts, in milliseconds:
    EXEC sp_OASetProperty @sftp, 'ConnectTimeoutMs', 15000
    EXEC sp_OASetProperty @sftp, 'IdleTimeoutMs', 15000

    --  Connect to the SSH server.
    --  The standard SSH port = 22
    --  The hostname may be a hostname or IP address.
    DECLARE @hostname nvarchar(4000)
    SELECT @hostname = 'www.my-ssh-server.com'
    DECLARE @port int
    SELECT @port = 22
    EXEC sp_OAMethod @sftp, 'Connect', @success OUT, @hostname, @port
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @sftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @chilkatGlob
        EXEC @hr = sp_OADestroy @sftp
        RETURN
      END

    --  Authenticate with the SSH server.  Chilkat SFTP supports
    --  both password-based authenication as well as public-key
    --  authentication.  This example uses password authenication.
    EXEC sp_OAMethod @sftp, 'AuthenticatePw', @success OUT, 'myLogin', 'myPassword'
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @sftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @chilkatGlob
        EXEC @hr = sp_OADestroy @sftp
        RETURN
      END

    --  After authenticating, the SFTP subsystem must be initialized:
    EXEC sp_OAMethod @sftp, 'InitializeSftp', @success OUT
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @sftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @chilkatGlob
        EXEC @hr = sp_OADestroy @sftp
        RETURN
      END

    --  --------------------
    --  Download a file
    --  --------------------
    DECLARE @localFilePath nvarchar(4000)
    SELECT @localFilePath = 'c:/temp/hamlet.xml'
    DECLARE @remoteFilePath nvarchar(4000)
    SELECT @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.
    DECLARE @task int
    EXEC sp_OAMethod @sftp, 'DownloadFileByNameAsync', @task OUT, @remoteFilePath, @localFilePath
    IF @task Is NULL 
      BEGIN
        EXEC sp_OAGetProperty @sftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @chilkatGlob
        EXEC @hr = sp_OADestroy @sftp
        RETURN
      END

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

    --  Schedule the task for running on the thread pool.  This changes the task's state
    --  from Inert to Live.
    EXEC sp_OAMethod @task, 'Run', @success OUT
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @task, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @task

        EXEC @hr = sp_OADestroy @chilkatGlob
        EXEC @hr = sp_OADestroy @sftp
        RETURN
      END

    --  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.
    DECLARE @curPctDone int
    SELECT @curPctDone = 0
    DECLARE @name nvarchar(4000)

    DECLARE @value nvarchar(4000)

    EXEC sp_OAGetProperty @task, 'Finished', @iTmp0 OUT
    WHILE @iTmp0 <> 1
      BEGIN

        EXEC sp_OAGetProperty @task, 'PercentDone', @iTmp0 OUT
        IF @iTmp0 <> @curPctDone
          BEGIN
            EXEC sp_OAGetProperty @task, 'PercentDone', @curPctDone OUT

            PRINT @curPctDone + ' percent done'
          END

        --  Check the progress info log.
        --  Emit any log entries..
        EXEC sp_OAGetProperty @task, 'ProgressLogSize', @iTmp0 OUT
        WHILE (@iTmp0 > 0)
          BEGIN
            --  Get the 1st entry, emit it, and then remove it..
            EXEC sp_OAMethod @task, 'ProgressInfoName', @name OUT, 0
            EXEC sp_OAMethod @task, 'ProgressInfoValue', @value OUT, 0

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



            PRINT @name + ': ' + @value
            EXEC sp_OAMethod @task, 'RemoveProgressInfo', NULL, 0
          END

        --  Sleep 100 ms.
        EXEC sp_OAMethod @task, 'SleepMs', NULL, 100

      END

    --  Just in case there are any remaining entries...
    EXEC sp_OAGetProperty @task, 'ProgressLogSize', @iTmp0 OUT
    WHILE (@iTmp0 > 0)
      BEGIN
        --  Get the 1st entry, emit it, and then remove it..
        EXEC sp_OAMethod @task, 'ProgressInfoName', @name OUT, 0
        EXEC sp_OAMethod @task, 'ProgressInfoValue', @value OUT, 0


        PRINT @name + ': ' + @value
        EXEC sp_OAMethod @task, 'RemoveProgressInfo', NULL, 0
      END

    --  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:
    EXEC sp_OAGetProperty @task, 'StatusInt', @iTmp0 OUT
    IF @iTmp0 <> 7
      BEGIN

        PRINT 'Task did not complete.'

        EXEC sp_OAGetProperty @task, 'Status', @sTmp0 OUT
        PRINT 'task status: ' + @sTmp0
        EXEC @hr = sp_OADestroy @task

        EXEC @hr = sp_OADestroy @chilkatGlob
        EXEC @hr = sp_OADestroy @sftp
        RETURN
      END

    --  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.
    EXEC sp_OAMethod @task, 'GetResultBool', @success OUT
    IF @success <> 1
      BEGIN
        --  The task's ResultErrorText contains what would have been in the LastErrorText property had
        --  the DownloadFileByName method been called synchronously.
        EXEC sp_OAGetProperty @task, 'ResultErrorText', @sTmp0 OUT
        PRINT @sTmp0
      END
    ELSE
      BEGIN

        PRINT 'File downloaded asynchronously.'
      END

    EXEC @hr = sp_OADestroy @task


    EXEC @hr = sp_OADestroy @chilkatGlob
    EXEC @hr = sp_OADestroy @sftp


END
GO

 

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