Click or drag to resize

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

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

Namespace:  Alphaleonis.Win32.Filesystem
Assembly:  AlphaFS (in AlphaFS.dll) Version: 2.0
Syntax
public static CopyMoveResult Move(
	string sourceFileName,
	string destinationFileName,
	MoveOptions moveOptions,
	CopyMoveProgressRoutine progressHandler,
	Object userProgressData,
	PathFormat pathFormat
)

Parameters

sourceFileName
Type: SystemString
The name of the file to move.
destinationFileName
Type: SystemString
The new path for the file.
moveOptions
Type: Alphaleonis.Win32.FilesystemMoveOptions
MoveOptions that specify how the file 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 file 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
A CopyMoveResult class with the status of the Move action.
Exceptions
Remarks

This method works across disk volumes, and it does not throw an exception if the source and destination are the same.

Note that if you attempt to replace a file by moving a file of the same name into that directory, you get an IOException.

You cannot use the Move method to overwrite an existing file.

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.

See Also