[This is preliminary documentation and is subject to change.]
When overriden in derived class deletes a file from the plugin's file system
Namespace: Tools.TotalCommanderTAssembly: Tools.TotalCommander (in Tools.TotalCommander.dll) Version: 1.5.3.38916 (1.5.3.38916)
Syntax
| C# |
|---|
[MethodNotSupportedAttribute] public virtual bool DeleteFile( string RemoteName ) |
| Visual Basic |
|---|
<MethodNotSupportedAttribute> _ Public Overridable Function DeleteFile ( _ RemoteName As String _ ) As Boolean |
| Visual C++ |
|---|
[MethodNotSupportedAttribute] public: virtual bool DeleteFile( String^ RemoteName ) |
| F# |
|---|
[<MethodNotSupportedAttribute>] abstract DeleteFile : RemoteName:string -> bool [<MethodNotSupportedAttribute>] override DeleteFile : RemoteName:string -> bool |
| JScript |
|---|
public function DeleteFile( RemoteName : String ) : boolean |
Parameters
- RemoteName
- Type: System..::..String
Name of the file to be deleted, with full path. The name always starts with a backslash, then the names returned by FindFirst(String, FindData%)/FindNext(Object, FindData%) separated by backslashes
Return Value
Return true if the file could be deleted, false if not.Remarks
When most-derived method implementation is marked with MethodNotSupportedAttribute, it means that the most derived plugin implementation does not support operation provided by the method.
 Note |
|---|
| Do not thow any other exceptions. Such exception will be passed to Total Commander which cannot handle it. |
Exceptions
| Exception | Condition |
|---|---|
| System..::..UnauthorizedAccessException | The user does not have required access |
| System.Security..::..SecurityException | Security error detected |
| System.IO..::..IOException | An IO error occured |
| System..::..NotSupportedException | The actual implementation is marked with MethodNotSupportedAttribute which means that the plugin doesnot support operation provided by the method. |
