Discuss this help topic in SecureBlackbox Forum

TElSftpClient.RemoveFile

TElSftpClient     See also     


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


Removes the file on a server side.

Declaration

[C#/Java]
    bool RemoveFile(string Filename);

[VB.NET]
    Function RemoveFile(ByVal Filename As String) As Boolean

[Pascal]
    function RemoveFile(Filename : string): Boolean;
    procedure RemoveFileSync(const Filename: string);

[C++]
    bool RemoveFile(const std::string &Filename);

[PHP]
    bool RemoveFile(string $Filename)

Parameters

  • Filename - the full name of the file to be removed.

Return value

    Returns True if the operation was completed successfully, and False otherwise.

Description

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

See also:     RemoveFiles     CreateFile     RenameFile    

Discuss this help topic in SecureBlackbox Forum