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

Called to get the default view to which Total Commander should switch when this file system plugin is entered.

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 FsContentGetDefaultView(
	sbyte* ViewContents,
	sbyte* ViewHeaders,
	sbyte* ViewWidths,
	sbyte* ViewOptions,
	int maxlen
)
Visual Basic
<EditorBrowsableAttribute(EditorBrowsableState.Never)> _
<CLSCompliantAttribute(False)> _
Public Function FsContentGetDefaultView ( _
	ViewContents As SByte*, _
	ViewHeaders As SByte*, _
	ViewWidths As SByte*, _
	ViewOptions As SByte*, _
	maxlen As Integer _
) As Integer
Visual C++
[EditorBrowsableAttribute(EditorBrowsableState::Never)]
[CLSCompliantAttribute(false)]
public:
int FsContentGetDefaultView(
	signed char* ViewContents, 
	signed char* ViewHeaders, 
	signed char* ViewWidths, 
	signed char* ViewOptions, 
	int maxlen
)
F#
[<EditorBrowsableAttribute(EditorBrowsableState.Never)>]
[<CLSCompliantAttribute(false)>]
member FsContentGetDefaultView : 
        ViewContents:nativeptr<sbyte> * 
        ViewHeaders:nativeptr<sbyte> * 
        ViewWidths:nativeptr<sbyte> * 
        ViewOptions:nativeptr<sbyte> * 
        maxlen:int -> int
JScript
JScript does not support APIs that consume or return unsafe types.

Parameters

ViewContents
Type: System..::..SByte*
Return the default fields for this plugin here, e.g. "[=<fs>.size.bkM2]\n[=fs.writetime]"
Note
Note that in C, you need to write \\n to return a backslash and 'n' instead of a newline character!
ViewHeaders
Type: System..::..SByte*
Return the default headers shown in the sorting header bar, e.g. "Size\nDate/Time"
ViewWidths
Type: System..::..SByte*
Return the default column widths shown in the sorting header bar, e.g. "148,23,-35,-35" Negative values mean that the field is right-aligned. The first two widths are for name and extension
ViewOptions
Type: System..::..SByte*
The two values, separated by a vertical line, mean:
  1. auto-adjust-width, or -1 for no adjust
  2. horizontal scrollbar flag
maxlen
Type: System..::..Int32

[Missing <param name="maxlen"/> documentation for "M:Tools.TotalCommanderT.FileSystemPlugin.FsContentGetDefaultView(System.SByte!System.Runtime.CompilerServices.IsSignUnspecifiedByte*,System.SByte!System.Runtime.CompilerServices.IsSignUnspecifiedByte*,System.SByte!System.Runtime.CompilerServices.IsSignUnspecifiedByte*,System.SByte!System.Runtime.CompilerServices.IsSignUnspecifiedByte*,System.Int32)"]

Return Value

Return true if you returned a default view, false if no default view should be shown.

Remarks

It's best to create a custom columns view in Total Commander, save it, and then copy the definitions from the Wincmd.ini to your plugin. The values in ViewContents and ViewHeaders are separated by a backslash and lowercase 'n' character.
Note
Note that in C, you need to write \\n to return a backslash and 'n' instead of a newline character!

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