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

When overriden in derived class, called to tell a plugin that a directory change has occurred, and the plugin should stop loading a value.

Namespace: Tools.TotalCommanderT
Assembly: Tools.TotalCommander (in Tools.TotalCommander.dll) Version: 1.5.3.38916 (1.5.3.38916)

Syntax

C#
[MethodNotSupportedAttribute]
public virtual void StopGetValue(
	string FileName
)
Visual Basic
<MethodNotSupportedAttribute> _
Public Overridable Sub StopGetValue ( _
	FileName As String _
)
Visual C++
[MethodNotSupportedAttribute]
public:
virtual void StopGetValue(
	String^ FileName
)
F#
[<MethodNotSupportedAttribute>]
abstract StopGetValue : 
        FileName:string -> unit 
[<MethodNotSupportedAttribute>]
override StopGetValue : 
        FileName:string -> unit 
JScript
public function StopGetValue(
	FileName : String
)

Parameters

FileName
Type: System..::..String
The name of the file for which [M:Tools.TotalCommanderT.ContentPluginBase.GetValue(System.String,System.Int32,System.Int32,System.Int32,Tools.TotalCommanderT.GetFieldValueFlags,System.Nullable`1{System.Double})] is currently being called.

Remarks

This function only needs to be implemented when handling very slow fields, e.g. the calculation of the total size of all files in a directory. It will be called only while a call to [M:Tools.TotalCommanderT.ContentPluginBase.GetValue(System.String,System.Int32,System.Int32,System.Int32,Tools.TotalCommanderT.GetFieldValueFlags,System.Nullable`1{System.Double})] is active in a background thread.

When most derived implementation of the function is marked with MethodNotSupportedAttribute, it means that the most derived plugin implementation does not support operation provided by the function.

Note
Do not throw any other exceptions. Such exception will be passed to Total Commander which cannot handle it.

Exceptions

ExceptionCondition
System..::..NotSupportedExceptionThe actual implementation is marked with MethodNotSupportedAttribute.

See Also

Collapse/expand Version History

1.5.3

  • This function is new in version 1.5.3