DeleteDirectory Method

Visual Basic
C#
Delphi
JScript
Managed Extensions for C++
C++/CLI

'Declaration
 
Public Function DeleteDirectory( _
   ByVal ftpDirectory As System.String _
) As System.Boolean

'Usage
 
Dim instance As SFTP
Dim ftpDirectory As System.String
Dim value As System.Boolean
 
value = instance.DeleteDirectory(ftpDirectory)

public System.bool DeleteDirectory( 
   System.string ftpDirectory
)

public function DeleteDirectory( 
    ftpDirectory: System.String
): System.Boolean;

public function DeleteDirectory( 
   ftpDirectory : System.String
) : System.boolean;

public: System.bool DeleteDirectory( 
   System.string* ftpDirectory
)

public:
System.bool DeleteDirectory( 
   System.String^ ftpDirectory
)

Parameters

ftpDirectory

Return Value

True if the directory is successfully deleted

C#

SFTP sftp = new SFTP(); //Trial Mode            
//SFTP sftp = new SFTP("place user name here", "place license key here");
 
// set the name of the SFTP server( its URL )
sftp.HostAddress = "some.sftp.server.com"; // replace with your sftp server
sftp.UserName  = "anonymous"; // replace with your user name
sftp.Password = "user@mail.com"; // replace with your password
 
 
//Delete a directory in the current FTP directory 
//It deletes all files and subdirectories within a directory 
System.Console.WriteLine("We are trying to delete all files in the TestDir directory and all its subdirs");
 
bool status = false;
 
status = sftp.DeleteDirectory("TestDir");
 
System.Console.WriteLine("TestDir and all its files and subfolders {0} deleted", status == true ? "has been" : "could not be");

Visual Basic

Dim sftp As SFTP = New SFTP() 'Trial Mode
'Dim sftp = New SFTP("place user name here", "place license key here")
 
' set the name of the SFTP server( its URL )
sftp.HostAddress = "some.sftp.server.com" ' replace with your sftp server
sftp.UserName  = "anonymous" ' replace with your user name
sftp.Password = "user@mail.com" ' replace with your password
 
 
'Delete a directory in the current FTP directory 
'It deletes all files and subdirectories within a directory 
System.Console.WriteLine("We are trying to delete all files in the TestDir directory and all its subdirs")
 
Dim status As Boolean = False
 
status = sftp.DeleteDirectory("TestDir")
 
If status = True Then
    System.Console.WriteLine("TestDir and all its files and subfolders {0} deleted","has been")
Else
    System.Console.WriteLine("TestDir and all its files and subfolders {0} deleted","could not be")
End If

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

SFTP Class
SFTP Members