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

The FileSystemPlugin type exposes the following members.

Constructors

  NameDescription
Protected methodFileSystemPlugin
Initializes a new instance of the FileSystemPlugin class

Methods

  NameDescription
Public methodContentGetDefaultSortOrder
Called when the user clicks on the sorting header above the columns.
(Inherited from ContentPluginBase.)
Public methodContentGetSupportedField
Called to enumerate all supported fields. FieldIndex is increased by 1 starting from 0 until the plugin returns NoMoreFields.
(Inherited from ContentPluginBase.)
Public methodContentGetSupportedFieldFlags
Called to get various information about a plugin variable. It's first called with FieldIndex=-1 to find out whether the plugin supports any special flags at all, and then for each field separately.
(Inherited from ContentPluginBase.)
Public methodContentGetValue
Called to retrieve the value of a specific field for a given file, e.g. the date field of a file.
(Inherited from ContentPluginBase.)
Public methodContentPluginUnloading
Called just before the plugin is unloaded, e.g. to close buffers, abort operations etc.
(Inherited from ContentPluginBase.)
Public methodContentSetValue
Called to set the value of a specific field for a given file, e.g. to change the date field of a file.
(Inherited from ContentPluginBase.)
Public methodContentStopGetValue
Called to tell a plugin that a directory change has occurred, and the plugin should stop loading a value.
(Inherited from ContentPluginBase.)
Public methodDeleteFile
When overriden in derived class deletes a file from the plugin's file system
Public methodDisconnect
When overridden in derived class, 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).
Public methodExctractCustomIcon
When overriden in derived class, called when a file/directory is displayed in the file list. It can be used to specify a custom icon for that file/directory.
Protected methodExecuteCommand
When overriden in derived class executes command in plugin space
Public methodExecuteFile
When overiden in derived class called to execute a file on the plugin's file system, or show its property sheet. It is also called to show a plugin configuration dialog when the user right clicks on the plugin root and chooses 'properties'. The plugin is then called with RemoteName="\" and Verb="properties" (requires TC>=5.51).
Public methodFindClose
When overriden in derived class performs custom clenup at end of a FindFirst(String, FindData%)/FindNext(Object, FindData%) loop, either after retrieving all files, or when the user aborts it.
Public methodFindFirst
When overriden in derived class retrieves the first file in a directory of the plugin's file system.
Public methodFindNext
When overriden in derived class retrieves the next file in a directory of the plugin's file system
Public methodFsContentGetDefaultView
Called to get the default view to which Total Commander should switch when this file system plugin is entered.
Public methodFsDeleteFile
Called to delete a file from the plugin's file system
Public methodFsDisconnect
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).
Public methodFsExecuteFile(HWND__*, SByte*, SByte*)
Called to execute a file on the plugin's file system, or show its property sheet. It is also called to show a plugin configuration dialog when the user right clicks on the plugin root and chooses 'properties'. The plugin is then called with RemoteName="\" and Verb="properties" (requires TC>=5.51).
Public methodFsExecuteFile(Void*, SByte*, SByte*)
Alternative function to FsExecuteFile(HWND__*, SByte*, SByte*) because ha have problems with exposing HWND type to managed code
Public methodFsExtractCustomIcon
Called when a file/directory is displayed in the file list. It can be used to specify a custom icon for that file/directory.
Public methodFsFindClose
Called to end a FsFindFirst(SByte*, _WIN32_FIND_DATAW*)/FsFindNext(Void*, _WIN32_FIND_DATAW*) loop, either after retrieving all files, or when the user aborts it
Public methodFsFindFirst
Called to retrieve the first file in a directory of the plugin's file system.
Public methodFsFindNext
Called to retrieve the next file in a directory of the plugin's file system
Public methodFsGetDefRootName
Called only when the plugin is installed. It asks the plugin for the default root name which should appear in the Network Neighborhood. This root name is NOT part of the path passed to the plugin when Totalcmd accesses the plugin file system! The root will always be "\", and all subpaths will be built from the directory names returned by the plugin.
Public methodFsGetFile
Called to transfer a file from the plugin's file system to the normal file system (drive letters or UNC).
Public methodFsGetLocalName
Gets local name of plugin file
Public methodFsGetPreviewBitmap
Called when a file/directory is displayed in thumbnail view. It can be used to return a custom bitmap for that file/directory.
Public methodFsInit
Public methodFsLinksToLocalFiles
Indicates if plugin is temporary panel-style plugin
Public methodFsMkDir
Create a directory on the plugin's file system.
Public methodFsPutFile
Called to transfer a file from the normal file system (drive letters or UNC) to the plugin's file system.
Public methodFsRemoveDir
Called to remove a directory from the plugin's file system.
Public methodFsRenMovFile
Called to transfer (copy or move) a file within the plugin's file system.
Public methodFsSetAttr
Called to set the (Windows-Style) file attributes of a file/dir. FsExecuteFile(HWND__*, SByte*, SByte*) is called for Unix-style attributes.
Public methodFsSetDefaultParams
Called immediately after [M:Tools.TotalCommanderT.FileSystemPlugin.FsInit(System.Int32,=FUNC:System.Int32(System.Int32,System.SByte!System.Runtime.CompilerServices.IsSignUnspecifiedByte*,System.SByte!System.Runtime.CompilerServices.IsSignUnspecifiedByte*,System.Int32),=FUNC:System.Void(System.Int32,System.Int32,System.SByte!System.Runtime.CompilerServices.IsSignUnspecifiedByte*),=FUNC:System.Int32(System.Int32,System.Int32,System.SByte!System.Runtime.CompilerServices.IsSignUnspecifiedByte*,System.SByte!System.Runtime.CompilerServices.IsSignUnspecifiedByte*,System.SByte!System.Runtime.CompilerServices.IsSignUnspecifiedByte*,System.Int32))].
Public methodFsSetTime
Called to set the (Windows-Style) file times of a file/dir.
Public methodFsStatusInfo
called just as an information to the plugin that a certain operation starts or ends. It can be used to allocate/free buffers, and/or to flush data from a cache. There is no need to implement this function if the plugin doesn't require it.
Protected methodFtpModeAdvertisement
When overriden in derived class called when Total COmmander advertises FTP conection mode to plugin via ExecuteFile(IntPtr, String%, String)
Public methodGetDefaultSortOrder
When overriden in derived class, called when the user clicks on the sorting header above the columns.
(Inherited from ContentPluginBase.)
Public methodGetDefaultView
When overriden in derived class called to get the default view to which Total Commander should switch when this file system plugin is entered.
Public methodGetFile
When overriden in derived class transfers a file from the plugin's file system to the normal file system (drive letters or UNC).
Public methodGetLocalName
When overriden in derved class gets local name of plugin file
Protected methodGetNextHandle
Gets next free handle for HandleDictionary
Public methodGetPreviewBitmap
When overriden in derved class called when a file/directory is displayed in thumbnail view. It can be used to return a custom bitmap for that file/directory.
Public methodGetSupportedFieldFlags
Called to get various information about a plugin variable. It's first called with FieldIndex=-1 to find out whether the plugin supports any special flags at all, and then for each field separately.
(Inherited from ContentPluginBase.)
Public methodGetValue (Inherited from ContentPluginBase.)
Protected methodHandleAdd
Adds object to HandleDictionary
Protected methodHandleGet
Gets object identified by handle
Protected methodHandleGetHandle
Gets handle of object in HandleDictionary
Protected methodHandleRemove(Int32)
Removes object from HandleDictionary identified by integral handle
Protected methodHandleRemove(Object)
Removes object from HandleDictionary
Protected methodHandleReplace
Raplaces object in HandleDictionary with another one.
Public methodInitializePlugin
Called when loading the plugin outside of Total Comander environment instead of [M:Tools.TotalCommanderT.FileSystemPlugin.FsInit(System.Int32,=FUNC:System.Int32(System.Int32,System.SByte!System.Runtime.CompilerServices.IsSignUnspecifiedByte*,System.SByte!System.Runtime.CompilerServices.IsSignUnspecifiedByte*,System.Int32),=FUNC:System.Void(System.Int32,System.Int32,System.SByte!System.Runtime.CompilerServices.IsSignUnspecifiedByte*),=FUNC:System.Int32(System.Int32,System.Int32,System.SByte!System.Runtime.CompilerServices.IsSignUnspecifiedByte*,System.SByte!System.Runtime.CompilerServices.IsSignUnspecifiedByte*,System.SByte!System.Runtime.CompilerServices.IsSignUnspecifiedByte*,System.Int32))]. The passed values should be stored in the plugin for later use.
Protected methodLogProc
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.
Protected methodLogProcConnect
Specialized version of the LogProc(LogKind, String) function used for logging conection open.
Protected methodLogProcTransferComplete
Specialized version of the LogProc(LogKind, String) function used for transfer completion advertisement.
Public methodMkDir
When overriden in derived class creates a directory on the plugin's file system.
Protected methodOnContentPluginUnloading
Called just before the plugin is unloaded, e.g. to close buffers, abort operations etc.
(Inherited from ContentPluginBase.)
Protected methodOnInit
When overriden in derived class provides custom code invoked when plugin is initialized.
Public methodOnOperationFinished
When overriden in derived class handles end of operation reported by Total Commander
Public methodOnOperationStarting
When overriden in derived class handles start of operation reported by Total Commander
Public methodOnOperationStatusChanged
When overiden in derived class handles operation status change reported by Total Commaner
Protected methodOpenFile
When overriden in derived class opens or executes given file.
Protected methodProgressProc
Callback function, which the plugin can call to show copy progress.
Public methodPutFile
When overriden in derived class transfers a file from the normal file system (drive letters or UNC) to the plugin's file system.
Public methodRemoveDir
When overriden in derived class removes a directory from the plugin's file system.
Public methodRenMovFile
When overriden in derived class called to transfer (copy or move) a file within the plugin's file system.
Protected methodRequestProc
callback function, which the plugin can call to request input from the user. When using one of the standard parameters, the request will be in the selected language.
Public methodSetAttr
When overriden in derived class sets the (Windows-Style) file attributes of a file/dir. ExecuteFile(IntPtr, String%, String) is called for Unix-style attributes.
Public methodSetDefaultParams
Called immediately after OnInit()()()().
Public methodSetTime
Public methodSetValue
When overriden in derived class called to set the value of a specific field for a given file, e.g. to change the date field of a file.
(Inherited from ContentPluginBase.)
Protected methodShowFileInfo
When overriden in derived class shows file properties for given file or directory.
Public methodStatusInfo
Called instead of FsStatusInfo(SByte*, Int32, Int32) when plugin is used outside of Total Commander.
Public methodStopGetValue
When overriden in derived class, called to tell a plugin that a directory change has occurred, and the plugin should stop loading a value.
(Inherited from ContentPluginBase.)

Properties

  NameDescription
Protected propertyFieldNameMaxLen
Gets maximal length of string that can be passed to FieldName.
(Inherited from ContentPluginBase.)
Protected propertyHandleDictionary
Gets dictionary containing objects referenced by Total Commander by handles
Public propertyInitialized
Gets value indicating if this plugin instance was initialized or not
Public propertyIsInTotalCommander
When plugin is initialized, gets value indicating if it was initialiuzed by Total Commander or .NET application
Public propertyLinksToLocalFiles
When overriden in derived class gets valud indicating if plugin is temporary panel-style plugin.
Public propertyName
Gets name of plugin
(Inherited from PluginBase.)
Protected propertyPluginNr
Gets plugin number this plugin instance is recognized by Total Commender under
Protected propertyPluginParams
Gets default parameters of the plugin
Public propertySupportedFields
When overriden in derived class gets all supported custom fields.
(Inherited from ContentPluginBase.)

See Also