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

Called to transfer (copy or move) a file within the plugin's file system.

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

Parameters

OldName
Type: System..::..SByte*
Name of the remote source file, with full path. The name always starts with a backslash, then the names returned by FsFindFirst(SByte*, _WIN32_FIND_DATAW*)/FsFindNext(Void*, _WIN32_FIND_DATAW*) separated by backslashes.
NewName
Type: System..::..SByte*
Name of the remote destination file, with full path. The name always starts with a backslash, then the names returned by FsFindFirst(SByte*, _WIN32_FIND_DATAW*)/FsFindNext(Void*, _WIN32_FIND_DATAW*) separated by backslashes.
Move
Type: System..::..Int32
If true, the file needs to be moved to the new location and name. Many file systems allow to rename/move a file without actually moving any of its data, only the pointer to it.
OverWrite
Type: System..::..Int32
Tells the function whether it should overwrite the target file or not. See notes below on how this parameter is used.
ri
Type: RemoteInfoStruct*
A structure of type [D:RemoteInfoStruct] which contains the parameters of the file being renamed/moved (not of the target file!). In TC 5.51, the fields are set as follows for directories: RemoteInfoStruct::SizeLow = 0, RemoteInfoStruct::SizeHigh = 0xFFFFFFFF

Return Value

One of the FileSystemExitCode values

Remarks

Total Commander usually calls this function twice: once with OverWrite==false. If the remote file exists, return FileExists. If it doesn't exist, try to copy the file, and return an appropriate error code.a second time with OverWrite==true, if the user chose to overwrite the file.

While copying the file, but at least at the beginning and the end, call ProgressProc(String, String, Int32) to show the copy progress and allow the user to abort the operation.

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

See Also