(SQL Server) FTP Bandwidth Throttle for Downloads

Demonstrates the Chilkat FTP2 download bandwidth throttling property : BandwidthThrottleDown.

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example requires the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @ftp int
    -- Use "Chilkat_9_5_0.Ftp2" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Ftp2', @ftp OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    EXEC sp_OASetProperty @ftp, 'Hostname', 'ftp.example.com'
    EXEC sp_OASetProperty @ftp, 'Username', 'login'
    EXEC sp_OASetProperty @ftp, 'Password', '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.
    DECLARE @success int
    EXEC sp_OAMethod @ftp, 'Connect', @success OUT
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @ftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @ftp
        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
        EXEC @hr = sp_OADestroy @ftp
        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
        EXEC @hr = sp_OADestroy @ftp
        RETURN
      END

    EXEC sp_OAMethod @ftp, 'Disconnect', @success OUT


    PRINT 'File Downloaded!'

    EXEC @hr = sp_OADestroy @ftp


END
GO