ComponentPro UltimateFtp

      Download(String, String, Boolean, FileOverwriteMode, SymlinksResolveAction) Method

      See AlsoMembers Options: Show AllLanguage Filter: AllSend comments on this topic to ComponentPro
      Downloads the content of the specified remote file or directory to the local directory. This method only downloads the items in the specified directory if the remotePath parameter does not end with a directory separator (e.g. '/'). To also create the directory in the destination, add a directory separator character at the end of that parameter.

      Syntax

      public FileSystemTransferStatistics Download(
         string remotePath, 
         string localPath, 
         bool recursive, 
         FileOverwriteMode fileExistsAction, 
         SymlinksResolveAction symlinksResolveAction = 2
      )

      Parameters

      remotePath
      The path and name of the remote directory where the files will be downloaded to the local folder. This parameter can include filtering masks to limit the files that are downloaded. For example, if ""(empty string) is specified, the entire contents of the current folder will be downloaded. If "*.txt" is used, all the files in the current folder that have the .TXT extension will be downloaded. If "/mydir/*.dat;*.cs,*.vb" is used (masks are delimited by ',', ';', and '|' characters), files with the DAT, CS, or VB extension in "/mydir" will be downloaded. If no masks specified, the whole content of the remote directory should be downloaded. If this value ends with a directory separator character like '/' or '\', the containing directory will also be downloaded. For example, if "/folder/" is used, files and subdirectories of "folder" directory and itself will be downloaded; the destination directory will contain "folder" directory and its contents. Attention: some servers may be case-sensitive!
      localPath
      The path of the local directory to receive files from the server.
      recursive
      A boolean value indicating whether to includes the source directory and all its subdirectories in the transfer operation.
      fileExistsAction
      Specifies the action taken on existing files.
      symlinksResolveAction
      Specifies the action taken on symlinks.

      Examples

      Download files from the local disk to the FTP server.

      using ComponentPro;
      using ComponentPro.IO;
      using ComponentPro.Net;
      
      ...
      
      using (Ftp ftp = new Ftp())
      {
          // Connect to the FTP server. 
          ftp.Connect("localhost");
      
          // Authenticate. 
          ftp.Authenticate("test", "test");
      
          ftp.Download(
              "/data/*.txt", // The remote directory on the FTP server containing files and folders to download. TXT files will be downloaded. 
              @"C:\dest", // The local directory. 
              true, // Download recursively 
              FileOverwriteMode.Overwrite, // Overwrite all existing files. 
              SymlinksResolveAction.Skip // If a symlink found, skip it. 
              );
      }

      Framework

      .NET Compact Framework.NET Compact Framework

      Supported version: 2.0, 3.5, and 3.9
      Assembly: ComponentPro.Ftp.CF (in ComponentPro.Ftp.CF.dll)

      .NET Framework.NET Framework

      Supported version: 2.0, 3.0, 3.5, 4.0, 4.5.x, 4.6.x and later
      Assembly: ComponentPro.Ftp (in ComponentPro.Ftp.dll)

      Portable Class Library for Windows Phone 8.1 and Windows 8.1 Store AppsPortable Class Library for Windows Phone 8.1 and Windows 8.1 Store Apps

      Supported version: 4.6.x and later
      Assembly: ComponentPro.Ftp.WinPcl (in ComponentPro.Ftp.WinPcl.dll)

      Universal Windows Platform (includes Windows 10 Mobile, Windows 10 Store Apps and Windows 10 IoT)Universal Windows Platform (includes Windows 10 Mobile, Windows 10 Store Apps and Windows 10 IoT)

      Supported version: 4.6.x and later
      Assembly: ComponentPro.Ftp.Uwp (in ComponentPro.Ftp.Uwp.dll)

      Xamarin AndroidXamarin Android

      Supported version: 2.3 and later
      Assembly: ComponentPro.Ftp.Android (in ComponentPro.Ftp.Android.dll)

      Xamarin MacXamarin Mac

      Supported version: 2.0.x and later
      Assembly: ComponentPro.Ftp.Mac (in ComponentPro.Ftp.Mac.dll)

      Xamarin iOSXamarin iOS

      Supported version: 5.1.x and later
      Assembly: ComponentPro.Ftp.iOS (in ComponentPro.Ftp.iOS.dll)

      See Also