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

Called to enumerate all supported fields. FieldIndex is increased by 1 starting from 0 until the plugin returns NoMoreFields.

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

Syntax

C#
[CLSCompliantAttribute(false)]
[EditorBrowsableAttribute(EditorBrowsableState.Never)]
public int ContentGetSupportedField(
	int FieldIndex,
	sbyte* FieldName,
	sbyte* Units,
	int maxlen
)
Visual Basic
<CLSCompliantAttribute(False)> _
<EditorBrowsableAttribute(EditorBrowsableState.Never)> _
Public Function ContentGetSupportedField ( _
	FieldIndex As Integer, _
	FieldName As SByte*, _
	Units As SByte*, _
	maxlen As Integer _
) As Integer
Visual C++
[CLSCompliantAttribute(false)]
[EditorBrowsableAttribute(EditorBrowsableState::Never)]
public:
int ContentGetSupportedField(
	int FieldIndex, 
	signed char* FieldName, 
	signed char* Units, 
	int maxlen
)
F#
[<CLSCompliantAttribute(false)>]
[<EditorBrowsableAttribute(EditorBrowsableState.Never)>]
member ContentGetSupportedField : 
        FieldIndex:int * 
        FieldName:nativeptr<sbyte> * 
        Units:nativeptr<sbyte> * 
        maxlen:int -> int
JScript
JScript does not support APIs that consume or return unsafe types.

Parameters

FieldIndex
Type: System..::..Int32
The index of the field for which TC requests information. Starting with 0, the FieldIndex is increased until the plugin returns an error.
FieldName
Type: System..::..SByte*
Here the plugin has to return the name of the field with index FieldIndex. The field may not contain the following chars: . (dot) | (vertical line) : (colon). You may return a maximum of maxlen characters, including the trailing 0.
Units
Type: System..::..SByte*
When a field supports several units like bytes, kbytes, Mbytes etc, they need to be specified here in the following form: bytes|kbytes|Mbytes . The separator is the vertical dash (Alt+0124). As field names, unit names may not contain a vertical dash, a dot, or a colon. You may return a maximum of maxlen characters, including the trailing 0.

If the field type is Enum, the plugin needs to return all possible values here. Example: The field "File Type" of the built-in content plugin can have the values "File", "Folder" and "Reparse point". The available choices need to be returned in the following form: File|Folder|Reparse point . The same separator is used as for Units. You may return a maximum of maxlen characters, including the trailing 0. The field type Enum does NOT support any units.

maxlen
Type: System..::..Int32
The maximum number of characters, including the trailing 0, which may be returned in each of the fields.

Return Value

One of the ContentFieldType values

Remarks

Please note that fields of type FullText only show up in the search function, not in the multi-rename tool or the file lists. All fields of this type MUST be placed at the END of the field list, otherwise you will get errors in Total Commander! This is necessary because these fields will be removed from field lists e.g. in the "configure custom column view" dialog. You should use the String type for shorter one line texts suitable for displaying in file lists and for renaming.
Note
Type FullText is not supported by file system plugin.

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

Unlike majority of Total Commander content plugin functions, this function is not implemented by function with same name but without the "Content" prefix. This function is implemented by getter of the SupportedFields property.

Exceptions

ExceptionCondition
System..::..InvalidOperationExceptionUncatchable exception is thrown when: Item at index FieldIndex in array returned by SupportedFields contains diallowed characters in Units -or- Length of FieldName is greater than maxlen-1 -or- Sum of lenghts of Units plus number of them, minus 1 is greater than maxlen-1 -or- Value of the FieldIndex property differs form index at which the instance was retuned.

See Also

Collapse/expand Version History

1.5.3

  • This function is new in version 1.5.3