TElSimpleSFTPClient.RemoveDirectory method

TElSimpleSFTPClient.RemoveDirectory

Removes the directory on a server side.

Declaration

[C#]
void RemoveDirectory(string Path);
void RemoveDirectory(string Path, bool Recursive);

[VB.NET]
Sub RemoveDirectory(ByVal Path As String)
Sub RemoveDirectory(ByVal Path As String, ByVal Recursive As Boolean)

[Pascal]
procedure RemoveDirectory(const Path : string); overload;
procedure RemoveDirectory(const Path : string; Recursive : boolean); overload;

[C++]
void RemoveDirectory(const std::string &Path);
void RemoveDirectory(const std::string &Path, bool Recursive);

[PHP]
void RemoveDirectory(string $Path)
void RemoveDirectory(string $Path, bool $Recursive)

[Java]
void removeDirectory(String Path, boolean Recursive);
void removeDirectory(String Path);

Parameters

Path - path to directory to be removed
Recursive - specifies, whether to remove directories recursively, i.e. including subdirectories

Description

Use this method to delete the directory specified by Path parameter.
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.