Discuss this help topic in SecureBlackbox Forum

TElSimpleSFTPClient.RemoveFiles

TElSimpleSFTPClient     See also     


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


Removes the file on a server side.

Declaration

[C#/Java]
    void RemoveFiles(string Path, string Mask, bool CaseSensitive, bool Recursive);
    void RemoveFiles(TElStringList List);
    void RemoveFiles(String[] List);

[VB.NET]
    Sub RemoveFiles(ByVal Path As String, ByVal Mask As String, ByVal CaseSensitive As Boolean, ByVal Recursive As Boolean)
    Sub RemoveFiles(ByVal List As TElStringList)
    Sub RemoveFiles(ByVal List As String[])

[Pascal]
    procedure RemoveFiles(Path, Mask : string; CaseSensitive : boolean; Recursive : boolean);
    procedure RemoveFiles(List : TStrings);

[C++]
    void RemoveFiles(const std::string &Path, const std::string &Mask, bool CaseSensitive, bool Recursive);
    void RemoveFiles(TStrings &List);
    void RemoveFiles(TStrings *List);

[PHP]
    void RemoveFiles(string $Path, string $Mask, bool $CaseSensitive, bool $Recursive)
    void RemoveFiles(TStrings $List)

Parameters

  • List - list of files to be removed
  • Path - path to the files to be removed
  • Mask - mask of the files to be removed
  • CaseSensitive - specifies, whether to treat filenames case-sensitively
  • Recursive - specifies, whether to remove files recursively, i.e. including subdirectories

Description

    Use this method to delete a number of files.
    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.

See also:     About file masks and regular expressions     RemoveFile     CreateFile     RenameFile    

Discuss this help topic in SecureBlackbox Forum