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

When overriden in derved class gets local name of plugin file

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

Syntax

C#
[MethodNotSupportedAttribute]
public virtual string GetLocalName(
	string RemoteName,
	int maxlen
)
Visual Basic
<MethodNotSupportedAttribute> _
Public Overridable Function GetLocalName ( _
	RemoteName As String, _
	maxlen As Integer _
) As String
Visual C++
[MethodNotSupportedAttribute]
public:
virtual String^ GetLocalName(
	String^ RemoteName, 
	int maxlen
)
F#
[<MethodNotSupportedAttribute>]
abstract GetLocalName : 
        RemoteName:string * 
        maxlen:int -> string 
[<MethodNotSupportedAttribute>]
override GetLocalName : 
        RemoteName:string * 
        maxlen:int -> string
JScript
public function GetLocalName(
	RemoteName : String, 
	maxlen : int
) : String

Parameters

RemoteName
Type: System..::..String
Full path to the file name in the plugin namespace, e.g. \somedir\file.ext
maxlen
Type: System..::..Int32
Maximum number of characters you can return. Do not return longer strings because uncatchable PathTooLongException will be throw by FsGetLocalName(SByte*, Int32).

Return Value

Return the path of the file on the local file system, e.g. c:\windows\file.ext; null if the name does not point to a local file. Do not return paths longer than MaxPath - 1 otherwise uncatchable PathTooLongException will be thrown.

Remarks

FsGetLocalName(SByte*, Int32) must not be implemented unless your plugin is a temporary file panel plugin! Temporary file panels just hold links to files on the local file system.
Note
Do not thow 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 which means that the plugin doesnot support operation provided by the method.

See Also