[This is preliminary documentation and is subject to change.]
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.
Namespace: Tools.TotalCommanderTAssembly: Tools.TotalCommander (in Tools.TotalCommander.dll) Version: 1.5.3.38916 (1.5.3.38916)
Syntax
| C# |
|---|
[CLSCompliantAttribute(false)] [EditorBrowsableAttribute(EditorBrowsableState.Never)] public void FsStatusInfo( sbyte* RemoteDir, int InfoStartEnd, int InfoOperation ) |
| Visual Basic |
|---|
<CLSCompliantAttribute(False)> _ <EditorBrowsableAttribute(EditorBrowsableState.Never)> _ Public Sub FsStatusInfo ( _ RemoteDir As SByte*, _ InfoStartEnd As Integer, _ InfoOperation As Integer _ ) |
| Visual C++ |
|---|
[CLSCompliantAttribute(false)] [EditorBrowsableAttribute(EditorBrowsableState::Never)] public: void FsStatusInfo( signed char* RemoteDir, int InfoStartEnd, int InfoOperation ) |
| F# |
|---|
[<CLSCompliantAttribute(false)>] [<EditorBrowsableAttribute(EditorBrowsableState.Never)>] member FsStatusInfo : RemoteDir:nativeptr<sbyte> * InfoStartEnd:int * InfoOperation:int -> unit |
| JScript |
|---|
|
Parameters
- RemoteDir
- Type: System..::..SByte*
This is the current source directory when the operation starts. May be used to find out which part of the file system is affected.
- InfoStartEnd
- Type: System..::..Int32
Information whether the operation starts or ends
- InfoOperation
- Type: System..::..Int32
Information of which operaration starts/ends
Remarks
Please note that future versions of the framework may send additional values!
This function has been added for the convenience of plugin writers. All calls to plugin functions will be enclosed in a pair of FsStatusInfo(SByte*, Int32, Int32) calls: At the start, FsStatusInfo(SByte*, Int32, Int32)(...,FS_STATUS_START,...) and when the operation is done FsStatusInfo(...,FS_STATUS_END,...). Multiple plugin calls can be between these two calls. For example, a download may contain multiple calls to FsGetFile(SByte*, SByte*, Int32, RemoteInfoStruct*), and FsFindFirst(SByte*, _WIN32_FIND_DATAW*), FsFindNext(Void*, _WIN32_FIND_DATAW*), FsFindClose(Void*) (for copying subdirs).
This function is called by Total Commander and is not intended for direct use.