TElSftpClient.RemoveDirectory method

TElSftpClient.RemoveDirectory

TElSftpClient See also

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

Removes the directory on a server side.

Declaration

[C#]
bool RemoveDirectory(string Path);

[VB.NET]
Function RemoveDirectory(ByVal Path As String) As Boolean

[Pascal]
function RemoveDirectory(Path : string): Boolean;
procedure RemoveDirectorySync(const Path: string);

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

[PHP]
bool RemoveDirectory(string $Path)

[Java]
boolean removeDirectory(String Path);

Parameters

Path - path to directory to be removed

Return value

True if operation was completed successfully;
False otherwise.

Description

Use this method to delete the directory specified by Path parameter. If the directory was successfully deleted, the OnSuccess event is fired. The OnError event is fired otherwise.