DirectoryInfoMoveTo Method (String, MoveOptions, CopyMoveProgressRoutine, Object, PathFormat) |
[AlphaFS] Moves a
DirectoryInfo instance and its contents to a new path,
MoveOptions can be specified,
and the possibility of notifying the application of its progress through a callback function.
Namespace:
Alphaleonis.Win32.Filesystem
Assembly:
AlphaFS (in AlphaFS.dll) Version: 2.0
Syntax 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 name and path to which to move this directory.
The destination cannot be another disk volume unless moveOptions contains CopyAllowed, or a directory with the identical name.
It can be an existing directory to which you want to add this directory as a subdirectory.
- 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:
CopyMoveResultA
CopyMoveResult class with the status of the Move action.
Exceptions Remarks Use this method to allow or prevent overwriting of an existing directory.
This method does not work across disk volumes unless moveOptions contains CopyAllowed.
Whenever possible, avoid using short file names (such as XXXXXX~1.XXX) with this method.
If two directories have equivalent short file names then this method may fail and raise an exception and/or result in undesirable behavior.
See Also