[This is preliminary documentation and is subject to change.]
The FileSystemPlugin type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
| FileSystemPlugin | Initializes a new instance of the FileSystemPlugin class |
Methods
| Name | Description | |
|---|---|---|
| ContentGetDefaultSortOrder | Called when the user clicks on the sorting header above the columns. (Inherited from ContentPluginBase.) | |
| ContentGetSupportedField | Called to enumerate all supported fields. FieldIndex is increased by 1 starting from 0 until the plugin returns NoMoreFields. (Inherited from ContentPluginBase.) | |
| ContentGetSupportedFieldFlags | 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.) | |
| ContentGetValue | Called to retrieve the value of a specific field for a given file, e.g. the date field of a file. (Inherited from ContentPluginBase.) | |
| ContentPluginUnloading | Called just before the plugin is unloaded, e.g. to close buffers, abort operations etc. (Inherited from ContentPluginBase.) | |
| ContentSetValue | 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.) | |
| ContentStopGetValue | Called to tell a plugin that a directory change has occurred, and the plugin should stop loading a value. (Inherited from ContentPluginBase.) | |
| DeleteFile | When overriden in derived class deletes a file from the plugin's file system | |
| Disconnect | 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). | |
| ExctractCustomIcon | 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. | |
| ExecuteCommand | When overriden in derived class executes command in plugin space | |
| ExecuteFile | 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). | |
| FindClose | 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. | |
| FindFirst | When overriden in derived class retrieves the first file in a directory of the plugin's file system. | |
| FindNext | When overriden in derived class retrieves the next file in a directory of the plugin's file system | |
| FsContentGetDefaultView | Called to get the default view to which Total Commander should switch when this file system plugin is entered. | |
| FsDeleteFile | Called to delete a file from the plugin's file system | |
| FsDisconnect | 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). | |
| FsExecuteFile(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). | |
| FsExecuteFile(Void*, SByte*, SByte*) | Alternative function to FsExecuteFile(HWND__*, SByte*, SByte*) because ha have problems with exposing HWND type to managed code | |
| FsExtractCustomIcon | Called when a file/directory is displayed in the file list. It can be used to specify a custom icon for that file/directory. | |
| FsFindClose | 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 | |
| FsFindFirst | Called to retrieve the first file in a directory of the plugin's file system. | |
| FsFindNext | Called to retrieve the next file in a directory of the plugin's file system | |
| FsGetDefRootName | 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. | |
| FsGetFile | Called to transfer a file from the plugin's file system to the normal file system (drive letters or UNC). | |
| FsGetLocalName | Gets local name of plugin file | |
| FsGetPreviewBitmap | Called when a file/directory is displayed in thumbnail view. It can be used to return a custom bitmap for that file/directory. | |
| FsInit | ||
| FsLinksToLocalFiles | Indicates if plugin is temporary panel-style plugin | |
| FsMkDir | Create a directory on the plugin's file system. | |
| FsPutFile | Called to transfer a file from the normal file system (drive letters or UNC) to the plugin's file system. | |
| FsRemoveDir | Called to remove a directory from the plugin's file system. | |
| FsRenMovFile | Called to transfer (copy or move) a file within the plugin's file system. | |
| FsSetAttr | Called to set the (Windows-Style) file attributes of a file/dir. FsExecuteFile(HWND__*, SByte*, SByte*) is called for Unix-style attributes. | |
| FsSetDefaultParams | 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))]. | |
| FsSetTime | Called to set the (Windows-Style) file times of a file/dir. | |
| FsStatusInfo | 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. | |
| FtpModeAdvertisement | When overriden in derived class called when Total COmmander advertises FTP conection mode to plugin via ExecuteFile(IntPtr, String%, String) | |
| GetDefaultSortOrder | When overriden in derived class, called when the user clicks on the sorting header above the columns. (Inherited from ContentPluginBase.) | |
| GetDefaultView | When overriden in derived class called to get the default view to which Total Commander should switch when this file system plugin is entered. | |
| GetFile | When overriden in derived class transfers a file from the plugin's file system to the normal file system (drive letters or UNC). | |
| GetLocalName | When overriden in derved class gets local name of plugin file | |
| GetNextHandle | Gets next free handle for HandleDictionary | |
| GetPreviewBitmap | 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. | |
| GetSupportedFieldFlags | 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.) | |
| GetValue | (Inherited from ContentPluginBase.) | |
| HandleAdd | Adds object to HandleDictionary | |
| HandleGet | Gets object identified by handle | |
| HandleGetHandle | Gets handle of object in HandleDictionary | |
| HandleRemove(Int32) | Removes object from HandleDictionary identified by integral handle | |
| HandleRemove(Object) | Removes object from HandleDictionary | |
| HandleReplace | Raplaces object in HandleDictionary with another one. | |
| InitializePlugin | 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. | |
| LogProc | 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. | |
| LogProcConnect | Specialized version of the LogProc(LogKind, String) function used for logging conection open. | |
| LogProcTransferComplete | Specialized version of the LogProc(LogKind, String) function used for transfer completion advertisement. | |
| MkDir | When overriden in derived class creates a directory on the plugin's file system. | |
| OnContentPluginUnloading | Called just before the plugin is unloaded, e.g. to close buffers, abort operations etc. (Inherited from ContentPluginBase.) | |
| OnInit | When overriden in derived class provides custom code invoked when plugin is initialized. | |
| OnOperationFinished | When overriden in derived class handles end of operation reported by Total Commander | |
| OnOperationStarting | When overriden in derived class handles start of operation reported by Total Commander | |
| OnOperationStatusChanged | When overiden in derived class handles operation status change reported by Total Commaner | |
| OpenFile | When overriden in derived class opens or executes given file. | |
| ProgressProc | Callback function, which the plugin can call to show copy progress. | |
| PutFile | When overriden in derived class transfers a file from the normal file system (drive letters or UNC) to the plugin's file system. | |
| RemoveDir | When overriden in derived class removes a directory from the plugin's file system. | |
| RenMovFile | When overriden in derived class called to transfer (copy or move) a file within the plugin's file system. | |
| RequestProc | 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. | |
| SetAttr | 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. | |
| SetDefaultParams | Called immediately after OnInit()()()(). | |
| SetTime | ||
| SetValue | 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.) | |
| ShowFileInfo | When overriden in derived class shows file properties for given file or directory. | |
| StatusInfo | Called instead of FsStatusInfo(SByte*, Int32, Int32) when plugin is used outside of Total Commander. | |
| StopGetValue | 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
| Name | Description | |
|---|---|---|
| FieldNameMaxLen | Gets maximal length of string that can be passed to FieldName. (Inherited from ContentPluginBase.) | |
| HandleDictionary | Gets dictionary containing objects referenced by Total Commander by handles | |
| Initialized | Gets value indicating if this plugin instance was initialized or not | |
| IsInTotalCommander | When plugin is initialized, gets value indicating if it was initialiuzed by Total Commander or .NET application | |
| LinksToLocalFiles | When overriden in derived class gets valud indicating if plugin is temporary panel-style plugin. | |
| Name | Gets name of plugin (Inherited from PluginBase.) | |
| PluginNr | Gets plugin number this plugin instance is recognized by Total Commender under | |
| PluginParams | Gets default parameters of the plugin | |
| SupportedFields | When overriden in derived class gets all supported custom fields. (Inherited from ContentPluginBase.) |