FileInfo.MoveTo Method (String, MoveOptions, CopyMoveProgressRoutine, Object, PathFormat)

FileInfoMoveTo Method (String, MoveOptions, CopyMoveProgressRoutine, Object, PathFormat)

[AlphaFS] Moves a specified file to a new location, providing the option to specify a new file name, MoveOptions can be specified.

Namespace: Alphaleonis.Win32.Filesystem
Assembly: AlphaFS (in AlphaFS.dll) Version: 2.0

Syntax

C++

Copy

public CopyMoveResult MoveTo(
	string destinationPath,
	MoveOptions moveOptions,
	CopyMoveProgressRoutine progressHandler,
	Object userProgressData,
	PathFormat pathFormat
)

Public Function MoveTo ( 
	destinationPath As String,
	moveOptions As MoveOptions,
	progressHandler As CopyMoveProgressRoutine,
	userProgressData As Object,
	pathFormat As PathFormat
) As CopyMoveResult

public:
CopyMoveResult^ MoveTo(
	String^ destinationPath, 
	MoveOptions moveOptions, 
	CopyMoveProgressRoutine^ progressHandler, 
	Object^ userProgressData, 
	PathFormat pathFormat
)

member MoveTo : 
        destinationPath : string * 
        moveOptions : MoveOptions * 
        progressHandler : CopyMoveProgressRoutine * 
        userProgressData : Object * 
        pathFormat : PathFormat -> CopyMoveResult

Parameters

destinationPath: Type: SystemString
The path to move the file to, which can specify a different file name.
moveOptions: Type: Alphaleonis.Win32.FilesystemMoveOptions
MoveOptions that specify how the directory is to be moved. This parameter can be .
progressHandler: Type: Alphaleonis.Win32.FilesystemCopyMoveProgressRoutine
A callback function that is called each time another portion of the directory has been moved. This parameter can be .
userProgressData: Type: SystemObject
The argument to be passed to the callback function. This parameter can be .
pathFormat: Type: Alphaleonis.Win32.FilesystemPathFormat
Indicates the format of the path parameter(s).

Return Value

Type: CopyMoveResult
Returns a CopyMoveResult class with the status of the Move action.

Exceptions

Exception	Condition
ArgumentException	Passed when the path parameter contains invalid characters, is empty, or contains only white spaces.
ArgumentNullException	Passed when path is .
DirectoryNotFoundException	Passed when the directory was not found.
FileNotFoundException	Passed if the file was not found.
IOException	Passed when an I/O error occurs.
NotSupportedException
UnauthorizedAccessException

Remarks

Use this method to allow or prevent overwriting of an existing file.

This method works across disk volumes.

For example, the file c:\MyFile.txt can be moved to d:\public and renamed NewFile.txt.

Whenever possible, avoid using short file names (such as XXXXXX~1.XXX) with this method.

If two files have equivalent short file names then this method may fail and raise an exception and/or result in undesirable behavior.

Reference

FileInfo Class

MoveTo Overload

Alphaleonis.Win32.Filesystem Namespace