VBScript

FTP Bandwidth Throttle for Downloads

See more FTP Examples

Demonstrates the Chilkat FTP2 download bandwidth throttling property : BandwidthThrottleDown. VBScript

Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
'Create a Unicode (utf-16) output text file.
Set outFile = fso.CreateTextFile("output.txt", True, True)

success = 0

' This example requires the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.

set ftp = CreateObject("Chilkat.Ftp2")

ftp.Hostname = "ftp.example.com"
ftp.Username = "login"
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.
ftp.BandwidthThrottleDown = 50000

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

' Connect and login to the FTP server.
success = ftp.Connect()
If (success <> 1) Then
    outFile.WriteLine(ftp.LastErrorText)
    WScript.Quit
End If

' 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.
success = ftp.ChangeRemoteDir("junk")
If (success <> 1) Then
    outFile.WriteLine(ftp.LastErrorText)
    WScript.Quit
End If

' Download a file.
localFilename = "hamlet.xml"
remoteFilename = "hamlet.xml"

success = ftp.GetFile(remoteFilename,localFilename)
If (success <> 1) Then
    outFile.WriteLine(ftp.LastErrorText)
    WScript.Quit
End If

success = ftp.Disconnect()

outFile.WriteLine("File Downloaded!")

outFile.Close