[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#
[EditorBrowsableAttribute(EditorBrowsableState.Never)]
[CLSCompliantAttribute(false)]
public int ContentGetSupportedFieldFlags(
	int FieldIndex
)
Visual Basic
<EditorBrowsableAttribute(EditorBrowsableState.Never)> _
<CLSCompliantAttribute(False)> _
Public Function ContentGetSupportedFieldFlags ( _
	FieldIndex As Integer _
) As Integer
Visual C++
[EditorBrowsableAttribute(EditorBrowsableState::Never)]
[CLSCompliantAttribute(false)]
public:
int ContentGetSupportedFieldFlags(
	int FieldIndex
)
F#
[<EditorBrowsableAttribute(EditorBrowsableState.Never)>]
[<CLSCompliantAttribute(false)>]
member ContentGetSupportedFieldFlags : 
        FieldIndex:int -> int
JScript
public function ContentGetSupportedFieldFlags(
	FieldIndex : int
) : int

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.

Remarks

Returning one of the Subst* flags instructs Total Commander to replace (substitute) the returned variable by the indicated default internal value if no plugin variable can be retrieved.

This function is called by Total Commander and is not intended for direct use.

See Also

Collapse/expand Version History

1.5.3

  • This function is new in version 1.5.3