[This is preliminary documentation and is subject to change.]

When overriden in derived class called when Total COmmander advertises FTP conection mode to plugin via ExecuteFile(IntPtr, String%, String)

Namespace: Tools.TotalCommanderT
Assembly: Tools.TotalCommander (in Tools.TotalCommander.dll) Version: 1.5.3.38916 (1.5.3.38916)

Syntax

C#
[MethodNotSupportedAttribute]
protected virtual ExecExitCode FtpModeAdvertisement(
	IntPtr hMainWin,
	string RemoteName,
	string mode
)
Visual Basic
<MethodNotSupportedAttribute> _
Protected Overridable Function FtpModeAdvertisement ( _
	hMainWin As IntPtr, _
	RemoteName As String, _
	mode As String _
) As ExecExitCode
Visual C++
[MethodNotSupportedAttribute]
protected:
virtual ExecExitCode FtpModeAdvertisement(
	IntPtr hMainWin, 
	String^ RemoteName, 
	String^ mode
)
F#
[<MethodNotSupportedAttribute>]
abstract FtpModeAdvertisement : 
        hMainWin:IntPtr * 
        RemoteName:string * 
        mode:string -> ExecExitCode 
[<MethodNotSupportedAttribute>]
override FtpModeAdvertisement : 
        hMainWin:IntPtr * 
        RemoteName:string * 
        mode:string -> ExecExitCode
JScript
protected function FtpModeAdvertisement(
	hMainWin : IntPtr, 
	RemoteName : String, 
	mode : String
) : ExecExitCode

Parameters

hMainWin
Type: System..::..IntPtr
Handle to Total Commander window.
RemoteName
Type: System..::..String
Name of current file or directrory. This can be an empty string.
mode
Type: System..::..String
FTP mode. I for binary, A for text and X*.txt *.whatever (X followed by list of masks separated by space) fro text mode. Plugin can ignore this.

Return Value

One of ExecExitCode values.

Remarks

Note
This method is called only when plugin implements ExecuteFile(IntPtr, String%, String) function and thah function calls base class method.

Exceptions

ExceptionCondition
System..::..UnauthorizedAccessExceptionThe user does not have required access
System.Security..::..SecurityExceptionSecurity error detected
System.IO..::..IOExceptionAn IO error occured
System..::..InvalidOperationExceptionExcution cannot be done from other reason
System..::..NotSupportedExceptionThe 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)

See Also