Discuss this help topic in SecureBlackbox Forum

TElSimpleSFTPClient.UploadFiles

TElSimpleSFTPClient     See also     


Filter: C#/Java  VB.NET  Pascal  C++  PHP  


Uploads files by mask.

Declaration

[C#/Java]
    void UploadFiles(string LocalPath, string LocalMask, string RemotePath, TSBFileTransferMode Mode, bool CaseSensitive, TSBCaseConversion CaseConversion, bool Recursive);
    void UploadFiles(string LocalPath, string LocalMask, string RemotePath, TSBFileTransferMode Mode, bool CaseSensitive, TSBCaseConversion CaseConversion, bool Recursive, bool DeleteFiles);
    void UploadFiles(string LocalPath, string LocalMask, string RemotePath, TSBFileTransferMode Mode, TSBFileCopyMode CopyMode, bool CaseSensitive, TSBCaseConversion CaseConversion, bool Recursive);

[VB.NET]
    Sub UploadFiles(ByVal LocalPath As String, ByVal LocalMask As String, ByVal RemotePath As String, ByVal Mode As TSBFileTransferMode, ByVal CaseSensitive As Boolean, ByVal CaseConversion As TSBCaseConversion, ByVal Recursive As Boolean)
    Sub UploadFiles(ByVal LocalPath As String, ByVal LocalMask As String, ByVal RemotePath As String, ByVal Mode As TSBFileTransferMode, ByVal CaseSensitive As Boolean, ByVal CaseConversion As TSBCaseConversion, ByVal Recursive As Boolean, ByVal DeleteFiles As Boolean)
    Sub UploadFiles(ByVal LocalPath As String, ByVal LocalMask As String, ByVal RemotePath As String, ByVal Mode As TSBFileTransferMode, ByVal CopyMode As TSBFileCopyMode, ByVal CaseSensitive As Boolean, ByVal CaseConversion As TSBCaseConversion, ByVal Recursive As Boolean)

[Pascal]
    procedure UploadFiles(const LocalPath, LocalMask: string; const RemotePath: string; Mode: TSBFileTransferMode; CaseSensitive: boolean; CaseConversion: TSBCaseConversion; Recursive: boolean);
    procedure UploadFiles(const LocalPath, LocalMask: string; const RemotePath: string; Mode: TSBFileTransferMode; CaseSensitive: boolean; CaseConversion: TSBCaseConversion; Recursive: boolean; DeleteFiles: boolean);
    procedure UploadFiles(const LocalPath, LocalMask: string; const RemotePath: string; Mode: TSBFileTransferMode; CopyMode: TSBFileCopyMode; CaseSensitive: boolean; CaseConversion: TSBCaseConversion; Recursive: boolean);

[C++]
    void UploadFiles(const std::string &LocalPath, const std::string &LocalMask, const std::string &RemotePath, TSBFileTransferMode Mode, bool CaseSensitive, TSBCaseConversion CaseConversion, bool Recursive);
    void UploadFiles(const std::string &LocalPath, const std::string &LocalMask, const std::string &RemotePath, TSBFileTransferMode Mode, bool CaseSensitive, TSBCaseConversion CaseConversion, bool Recursive, bool DeleteFiles);
    void UploadFiles(const std::string &LocalPath, const std::string &LocalMask, const std::string &RemotePath, TSBFileTransferMode Mode, TSBFileCopyMode CopyMode, bool CaseSensitive, TSBCaseConversion CaseConversion, bool Recursive);

[PHP]
    void UploadFiles(string $LocalPath, string $LocalMask, string $RemotePath, integer $Mode, bool $CaseSensitive, integer $CaseConversion, bool $Recursive)
    void UploadFiles(string $LocalPath, string $LocalMask, string $RemotePath, integer $Mode, bool $CaseSensitive, integer $CaseConversion, bool $Recursive, bool $DeleteFiles)
    void UploadFiles(string $LocalPath, string $LocalMask, string $RemotePath, integer $Mode, integer $CopyMode, bool $CaseSensitive, integer $CaseConversion, bool $Recursive)

Parameters

  • LocalPath - local path to search for files
  • LocalMask - the mask to match the local files to
  • RemotePath - the path to store the files
  • Mode - specifies what to do if the file with the same name already exists
  • CopyMode - specifies what should be done with the file after successful copying.
  • CaseSensitive - specifies whether filename matching [to mask] is case-sensitive
  • CaseConversion - specifies whether case conversion must be applied to file names as they are uploaded
  • Recursive - specifies if the subdirectories should also be scanned for matching files
  • DeleteFiles - set to True to delete all files in the directory and its subdirectories after the files have been copied.

TSBFileTransferMode values:


TSBFileCopyMode values:


TSBCaseConversion values:


Description

    Use this method to upload one or more file from the local disk (or in virtual file system, if the appropriate file system adapter is used) to the server. The method uses PipelineLength and UploadBlockSize to calculate the size of the chunks, which are sent to the server. To select ASCII or binary transfer mode use ASCIIMode property.

    Files are chosen by mask which can be a simple mask, set of masks or regular expression (read more about masks).

    In case of error, EElSFTPError exception containing SFTP error code, is raised. For more information on error handling, please read the corresponding how-to article.

Discuss this help topic in SecureBlackbox Forum