FTP Bandwidth Throttle for Downloads

Demonstrates the Chilkat FTP2 download bandwidth throttling property : BandwidthThrottleDown.

Download Chilkat FTP2 ActiveX

CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @sTmp0 nvarchar(4000)
    DECLARE @ftp int
    EXEC @hr = sp_OACreate 'Chilkat.Ftp2', @ftp OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int

    --  Any string unlocks the component for the 1st 30-days.
    EXEC sp_OAMethod @ftp, 'UnlockComponent', @success OUT, 'Anything for 30-day trial'
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @ftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        RETURN
      END

    EXEC sp_OASetProperty @ftp, 'Hostname', 'www.example-code.com'
    EXEC sp_OASetProperty @ftp, 'Username', '****'
    EXEC sp_OASetProperty @ftp, 'Password', '****'

    --  To use FTP bandwidth throttling, set the BandwidthThrottleDown
    --  property to a maximum desired bytes/second:
    --  This example limits the download to 50K per second.
    EXEC sp_OASetProperty @ftp, 'BandwidthThrottleDown', 50000

    --  The default data transfer mode is "Active" as opposed to "Passive".

    --  Connect and login to the FTP server.
    EXEC sp_OAMethod @ftp, 'Connect', @success OUT
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @ftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        RETURN
      END

    --  Change to the remote directory where the file is located.
    --  This step is only necessary if the file is not in the root directory
    --  for the FTP account.
    EXEC sp_OAMethod @ftp, 'ChangeRemoteDir', @success OUT, 'junk'
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @ftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        RETURN
      END

    --  Download a file.
    DECLARE @localFilename nvarchar(4000)

    SELECT @localFilename = 'hamlet.xml'
    DECLARE @remoteFilename nvarchar(4000)

    SELECT @remoteFilename = 'hamlet.xml'

    EXEC sp_OAMethod @ftp, 'GetFile', @success OUT, @remoteFilename, @localFilename
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @ftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        RETURN
      END

    EXEC sp_OAMethod @ftp, 'Disconnect', NULL

    PRINT 'File Downloaded!'
END
GO