[This is preliminary documentation and is subject to change.]
Assembly: Tools.TotalCommander (in Tools.TotalCommander.dll) Version: 1.5.3.38916 (1.5.3.38916)
Syntax
| C# |
|---|
[EditorBrowsableAttribute(EditorBrowsableState.Never)] [CLSCompliantAttribute(false)] public int FsLinksToLocalFiles() |
| Visual Basic |
|---|
<EditorBrowsableAttribute(EditorBrowsableState.Never)> _ <CLSCompliantAttribute(False)> _ Public Function FsLinksToLocalFiles As Integer |
| Visual C++ |
|---|
[EditorBrowsableAttribute(EditorBrowsableState::Never)] [CLSCompliantAttribute(false)] public: int FsLinksToLocalFiles() |
| F# |
|---|
[<EditorBrowsableAttribute(EditorBrowsableState.Never)>] [<CLSCompliantAttribute(false)>] member FsLinksToLocalFiles : unit -> int |
| JScript |
|---|
public function FsLinksToLocalFiles() : int |
Return Value
True if the plugin is a temporary panel-style plugin; false if the plugin is a normal file system plugin
Remarks
If your plugin is a temporary panel plugin, the following functions MUST be thread-safe (can be called from background transfer manager):
- FsLinksToLocalFiles()()()()
- FsFindFirst(SByte*, _WIN32_FIND_DATAW*)
- FsFindNext(Void*, _WIN32_FIND_DATAW*)
- FsFindClose(Void*)
- FsGetLocalName(SByte*, Int32)
This means that when uploading subdirectories from your plugin to FTP in the background, Total Commander will call these functions in a background thread. If the user continues to work in the foreground, calls to FsFindFirst(SByte*, _WIN32_FIND_DATAW*) and FsFindNext(Void*, _WIN32_FIND_DATAW*) may be occuring at the same time! Therefore it's very important to use the search handle to keep temporary information about the search.
FsStatusInfo(SByte*, Int32, Int32) will NOT be called from the background thread!
This function is called by Total Commander and is not intended for direct use. Plugin implements this function via the LinksToLocalFiles property.