NET SFTP Library
SynchronizeDownload(String,String,Boolean,String) Method






KellermanSoftware.NetSFtpLibrary Namespace > SFTP Class > SynchronizeDownload Method : SynchronizeDownload(String,String,Boolean,String) Method
The local path to put the directory
The FTP directory to download
If true, download subdirectories
The file pattern to match
Transfer files that meet the wildcard pattern. If the file meets the wildcard pattern it is checked if it does not exist locally OR it has a different byte count, or has a modification date difference in seconds greater than 60. The hour difference between the local machine and the SSH server is taken into account when CalcHourDifference has been called. By default all files and sub directories are attempted to be synchronized.
Syntax
'Declaration
 
Public Overloads Function SynchronizeDownload( _
   ByVal localDirectory As System.String, _
   ByVal ftpDirectory As System.String, _
   ByVal subDirectories As System.Boolean, _
   ByVal wildCardPattern As System.String _
) As System.Collections.Generic.List(Of TransferInfo)
'Usage
 
Dim instance As SFTP
Dim localDirectory As System.String
Dim ftpDirectory As System.String
Dim subDirectories As System.Boolean
Dim wildCardPattern As System.String
Dim value As System.Collections.Generic.List(Of TransferInfo)
 
value = instance.SynchronizeDownload(localDirectory, ftpDirectory, subDirectories, wildCardPattern)
public System.Collections.Generic.List<TransferInfo> SynchronizeDownload( 
   System.string localDirectory,
   System.string ftpDirectory,
   System.bool subDirectories,
   System.string wildCardPattern
)
public function SynchronizeDownload( 
    localDirectory: System.String;
    ftpDirectory: System.String;
    subDirectories: System.Boolean;
    wildCardPattern: System.String
): System.Collections.Generic.List; 
public function SynchronizeDownload( 
   localDirectory : System.String,
   ftpDirectory : System.String,
   subDirectories : System.boolean,
   wildCardPattern : System.String
) : System.Collections.Generic.List;
public: System.Collections.Generic.List<TransferInfo*>* SynchronizeDownload( 
   System.string* localDirectory,
   System.string* ftpDirectory,
   System.bool subDirectories,
   System.string* wildCardPattern
) 
public:
System.Collections.Generic.List<TransferInfo^>^ SynchronizeDownload( 
   System.String^ localDirectory,
   System.String^ ftpDirectory,
   System.bool subDirectories,
   System.String^ wildCardPattern
) 

Parameters

localDirectory
The local path to put the directory
ftpDirectory
The FTP directory to download
subDirectories
If true, download subdirectories
wildCardPattern
The file pattern to match

Return Value

A list of files that were transfered
Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

Reference

SFTP Class
SFTP Members
Overload List