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

Called when the user presses the Disconnect button in the FTP connections toolbar. This toolbar is only shown if Connect is passed to LogProc(LogKind, String).

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

Syntax

C#
[CLSCompliantAttribute(false)]
[EditorBrowsableAttribute(EditorBrowsableState.Never)]
public int FsDisconnect(
	sbyte* DisconnectRoot
)
Visual Basic
<CLSCompliantAttribute(False)> _
<EditorBrowsableAttribute(EditorBrowsableState.Never)> _
Public Function FsDisconnect ( _
	DisconnectRoot As SByte* _
) As Integer
Visual C++
[CLSCompliantAttribute(false)]
[EditorBrowsableAttribute(EditorBrowsableState::Never)]
public:
int FsDisconnect(
	signed char* DisconnectRoot
)
F#
[<CLSCompliantAttribute(false)>]
[<EditorBrowsableAttribute(EditorBrowsableState.Never)>]
member FsDisconnect : 
        DisconnectRoot:nativeptr<sbyte> -> int
JScript
JScript does not support APIs that consume or return unsafe types.

Parameters

DisconnectRoot
Type: System..::..SByte*
This is the root dir which was passed to LogProc(LogKind, String) when connecting. It allows the plugin to have serveral open connections to different file systems (e.g. ftp servers). Should be either \ (for a single possible connection) or \Servername (e.g. when having multiple open connections).

Return Value

Return TRUE if the connection was closed (or never open), FALSE if it couldn't be closed.

Remarks

To get calls to this function, the plugin MUST call LogProc(LogKind, String) with the parameter Connect. The parameter LogString MUST start with "CONNECT", followed by one whitespace and the root of the file system which has been connected. This file system root will be passed to FsDisconnect(SByte*) when the user presses the Disconnect button, so the plugin knows which connection to close. Do NOT call LogProc(LogKind, String) with Connect if your plugin does not require connect/disconnect! ExamplesFTP requires connect/disconnect. Connect can be done automatically when the user enters a subdir, disconnect when the user clicks the Disconnect button.Access to local file systems (e.g. Linux EXT2) does not require connect/disconnect, so don't call LogProc(LogKind, String) with the parameter Connect.

This function is called by Total Commander and is not intended for direct use

See Also