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

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.

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

Syntax

C#
public virtual FieldFlags GetSupportedFieldFlags(
	int FieldIndex
)
Visual Basic
Public Overridable Function GetSupportedFieldFlags ( _
	FieldIndex As Integer _
) As FieldFlags
Visual C++
public:
virtual FieldFlags GetSupportedFieldFlags(
	int FieldIndex
)
F#
abstract GetSupportedFieldFlags : 
        FieldIndex:int -> FieldFlags 
override GetSupportedFieldFlags : 
        FieldIndex:int -> FieldFlags
JScript
public function GetSupportedFieldFlags(
	FieldIndex : int
) : FieldFlags

Parameters

FieldIndex
Type: System..::..Int32
The index of the field for which flags should be returned.
Parameter valueMeaning
-1Return a combination (or) of all supported flags
>=0Return the field-specific flags

Return Value

The function needs to return a combination of the FieldFlags flags.
Note
Only one of Subst*/PassThroughSize flags should be set.

Remarks

Note
Do not throw any other exceptions. Such exception will be passed to Total Commander which cannot handle it.
Unlike majority of plugin functions this function is not decorated with MethodNotSupportedAttribute, does not throw NotSupportedException when called without being overriden in derived class and it even provides functionality. You usually don't need to override this function because it works over flags retuned by SupportedFields (Flags) for FieldIndex -1 as well as for all the valid indexes.

Exceptions

ExceptionCondition
System..::..NotSupportedExceptionThe actual implementation is marked with MethodNotSupportedAttribute. See notes in remarks section.
System..::..ArgumentOutOfRangeExceptionThe FieldIndex is out of range of fields as returned by SupportedFields. Throwing this exception has same effect as returning zero.

See Also

Collapse/expand Version History

1.5.3

  • This function is new in version 1.5.3