[This is preliminary documentation and is subject to change.]
When overriden in derived class executes command in plugin space
Namespace: Tools.TotalCommanderTAssembly: Tools.TotalCommander (in Tools.TotalCommander.dll) Version: 1.5.3.38916 (1.5.3.38916)
Syntax
| C# |
|---|
[MethodNotSupportedAttribute] protected virtual ExecExitCode ExecuteCommand( IntPtr hMainWin, ref string RemoteName, string command ) |
| Visual Basic |
|---|
<MethodNotSupportedAttribute> _ Protected Overridable Function ExecuteCommand ( _ hMainWin As IntPtr, _ ByRef RemoteName As String, _ command As String _ ) As ExecExitCode |
| Visual C++ |
|---|
[MethodNotSupportedAttribute] protected: virtual ExecExitCode ExecuteCommand( IntPtr hMainWin, String^% RemoteName, String^ command ) |
| F# |
|---|
[<MethodNotSupportedAttribute>] abstract ExecuteCommand : hMainWin:IntPtr * RemoteName:string byref * command:string -> ExecExitCode [<MethodNotSupportedAttribute>] override ExecuteCommand : hMainWin:IntPtr * RemoteName:string byref * command:string -> ExecExitCode |
| JScript |
|---|
protected function ExecuteCommand( hMainWin : IntPtr, RemoteName : String, command : String ) : ExecExitCode |
Parameters
- hMainWin
- Type: System..::..IntPtr
Handle to Total Commander window.
- RemoteName
- Type: System..::..String%
Full path of currently show directory in Total Commander. Includes trailing \. If command changes current directory (like cd in Total Commander) asingn full path of new directory to this parameter. Total COmmander will navigate there.Do not assign string longer than MaxPath-1 or uncatchable PathTooLongException will be thrown.
- command
- Type: System..::..String
Text of command to be executed. It's up to plugin authow which commads to support, but cd is very common.
Return Value
[Missing <returns> documentation for "M:Tools.TotalCommanderT.FileSystemPlugin.ExecuteCommand(System.IntPtr,System.String@,System.String)"]
Remarks
| This method is called only when plugin implements ExecuteFile(IntPtr, String%, String) function and thah function calls base class method. |
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..::..InvalidOperationException | Excution cannot be done from other reason |
| System..::..NotSupportedException | The actual implementation is marked with MethodNotSupportedAttribute which means that the plugin doesnot support operation provided by the method and all most derived implementations of following methods are marked with MethodNotSupportedAttribute as well: FtpModeAdvertisement(IntPtr, String, String), OpenFile(IntPtr, String%), ShowFileInfo(IntPtr, String), ExecuteCommand(IntPtr, String%, String) |