TElSimpleSFTPClient.UploadFiles method

Discuss this help topic in SecureBlackbox Forum

TElSimpleSFTPClient.UploadFiles

TElSimpleSFTPClient See also

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

Uploads files by mask.

Declaration

[C#]
    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); overload;
    procedure UploadFiles(const LocalPath, LocalMask : string; const RemotePath : string; Mode : TSBFileTransferMode; CaseSensitive : boolean; CaseConversion : TSBCaseConversion; Recursive : boolean; DeleteFiles : boolean); overload;
    procedure UploadFiles(const LocalPath, LocalMask : string; const RemotePath : string; Mode : TSBFileTransferMode; CopyMode : TSBFileCopyMode; CaseSensitive : boolean; CaseConversion : TSBCaseConversion; Recursive : boolean); overload;

[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)

[Java]
    void uploadFiles(String LocalPath, String LocalMask, String RemotePath, TSBFileTransferMode Mode, TSBFileCopyMode CopyMode, boolean CaseSensitive, TSBCaseConversion CaseConversion, boolean Recursive);
    void uploadFiles(String LocalPath, String LocalMask, String RemotePath, TSBFileTransferMode Mode, boolean CaseSensitive, TSBCaseConversion CaseConversion, boolean Recursive);
    void uploadFiles(String LocalPath, String LocalMask, String RemotePath, TSBFileTransferMode Mode, boolean CaseSensitive, TSBCaseConversion CaseConversion, boolean Recursive, boolean DeleteFiles);

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:

[.NET] [C++]	[Pascal]	Description
ftmOverwrite = 0	ftmOverwrite	The file will be overwritten
ftmSkip = 1	ftmSkip	The file will be skipped if the file with the same name exists
ftmAppendToEnd = 2	ftmAppend	All data from the source file isappended to the end of the destination file (if itexists). This mode is useful, for example, for updatingthe remote log file.
ftmResume = 3	ftmResume	Resumes the transfer of the file by transferring the data from the source file (starting from position specified in RestartFrom and up to the end) to the destination file (the data is written to position specified in RestartFrom ). This mode is used to resume the broken upload or download. In Resume mode the component compares the sizes of source and destination files (streams). If the size of the destination is smaller than the size of the source, the transfer is restarted from the position equal to the destination size (resuming the broken transfer). Resume mode doesn't compare file times, so your application should only use this mode if it (or the user) knows that the destination file is an incompletely transferred source file, and not, e.g., an older version of the same file.
ftmOverwriteIfDiffSize = 4	ftmOverwriteIfDiffSize	Defines a conditional overwrite onlywhen the file size is different. NOTE: file size isdetermined using the chosen transfer type (ascii/binary).In ASCII mode the file size can be determinedincorrectly, and you should not use conditionaloverwrite then.
ftmSaveWithNewName = 5	ftmSaveWithNewName	When a file has been transferred, and another file with the same name already exists, the new file will be saved with a new name.For each such file an OnFileNameChangeNeeded event is fired.
ftmRenameExistingTarget = 6	ftmRenameExistingTarget	In contrary to the ftmSaveWithNewName option, the existing file will be renamed, while the new file is saved under its original name.For each such file an OnFileNameChangeNeeded event is fired.

TSBFileCopyMode values:

[.NET] [C++]	[Pascal]	Description
fcmCopy = 0	fcmCopy	Simply copy.
fcmCopyAndDeleteImmediate = 1	fcmCopyAndDeleteImmediate	Delete each file immediatly after it has been copied.
fcmCopyAndDeleteOnCompletion = 2	fcmCopyAndDeleteOnCompletion	Delete all files in the directory and its subdirectories after the files have been copied.

TSBCaseConversion values:

[.NET] [C++]	[Pascal]	Description
sccNone = 0	sccNone	Case conversion is not performed
sccLower = 1	sccLower	File names are converted to lowercase on destination system
sccUpper = 2	sccUpper	File names are converted to uppercase on destination system

Description

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

Files are chosen by the mask which can be a simple mask, a set of masks or a regular expression (read more about masks).
Since SecureBlackbox version 13, file masks in group operations support expressions.

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

See also: File masks in group operations About file masks and regular expressions About file system adapters UploadStream DownloadFiles ASCIIMode FileSystemAdapter UploadBlockSize PipelineLength

Discuss this help topic in SecureBlackbox Forum