[This is preliminary documentation and is subject to change.]
Callback function, which the plugin can call to show the FTP connections toolbar, and to pass log messages to it. Totalcmd can show these messages in the log window (ftp toolbar) and write them to a log file.
Namespace:
Tools.TotalCommanderTAssembly: Tools.TotalCommander (in Tools.TotalCommander.dll) Version: 1.5.2.0
Syntax
| C# |
|---|
public delegate void LogCallback( FileSystemPlugin sender, LogKind MsgType, string LogString ) |
| Visual Basic (Declaration) |
|---|
Public Delegate Sub LogCallback ( _ sender As FileSystemPlugin, _ MsgType As LogKind, _ LogString As String _ ) |
| Visual C++ |
|---|
public delegate void LogCallback( FileSystemPlugin^ sender, LogKind MsgType, String^ LogString ) |
| J# |
|---|
/** @delegate */ public delegate void LogCallback( FileSystemPlugin sender, LogKind MsgType, String LogString ) |
| JScript |
|---|
|
Parameters
- sender
- Type: Tools.TotalCommanderT..::.FileSystemPlugin
- MsgType
- Type: Tools.TotalCommanderT..::.LogKind
Can be one of the LogKind flags
- LogString
- Type: System..::.String
String which should be logged.When MsgTypeis Connect, the string MUST have a specific format:
"CONNECT" followed by a single whitespace, then the root of the file system which was connected, without trailing backslash. Example: CONNECT \Filesystem
When MsgType is TransferComplete, this parameter should contain both the source and target names, separated by an arrow " -> ", e.g. Download complete: \Filesystem\dir1\file1.txt -> c:\localdir\file1.txt
Remarks
Do NOT call LogProc(LogKind, String) with Connect if your plugin does not require connect/disconnect! If you call it with MsgTypeConnect, the function Disconnect(String) will be called (if defined) when the user presses the Disconnect button.