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

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

Parameters

RemoteName
Type: System..::..SByte*

In: Full path to the file name in the plugin namespace, e.g. \somedir\file.ext

Out: Return the path of the file on the local file system, e.g. c:\windows\file.ext

maxlen
Type: System..::..Int32
Maximum number of characters you can return in RemoteName, including the final 0.

Return Value

True if the name points to a local file, which is returned in RemoteName. False if the name does not point to a local file, RemoteName is left unchanged.

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.

This function is called by Total Commander and is not intended for direct use. Plugin implements this function via the LinksToLocalFiles property.

Exceptions

ExceptionCondition
System.IO..::..PathTooLongExceptionString longer than maxlen - 1 is returned by FsGetLocalName(SByte*, Int32).

See Also