DeleteFile Method

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

'Declaration
 
Public Function DeleteFile( _
   ByVal fileName As System.String _
) As System.Boolean

'Usage
 
Dim instance As SFTP
Dim fileName As System.String
Dim value As System.Boolean
 
value = instance.DeleteFile(fileName)

public System.bool DeleteFile( 
   System.string fileName
)

public function DeleteFile( 
    fileName: System.String
): System.Boolean;

public function DeleteFile( 
   fileName : System.String
) : System.boolean;

public: System.bool DeleteFile( 
   System.string* fileName
)

public:
System.bool DeleteFile( 
   System.String^ fileName
)

Parameters

fileName: The file to delete

Return Value

True if the file is successfully deleted OR the file does not exist

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 file in the current FTP directory 
System.Console.WriteLine("We are trying to delete TestFile");
 
bool status = sftp.DeleteFile("TestFile");
 
System.Console.WriteLine("TestFile {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 file in the current FTP directory
System.Console.WriteLine("We are trying to delete TestFile")
 
Dim status As Boolean = sftp.DeleteFile("TestFile")
 
If status = True Then
    System.Console.WriteLine("TestFile {0} deleted","has been")
Else
    System.Console.WriteLine("TestFile {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