DirectoryMove Method (KernelTransaction, String, String, MoveOptions, CopyMoveProgressRoutine, Object, PathFormat) |
[AlphaFS] Moves a file or a directory and its contents to a new location,
MoveOptions can be specified,
and the possibility of notifying the application of its progress through a callback function.
Namespace: Alphaleonis.Win32.FilesystemAssembly: AlphaFS (in AlphaFS.dll) Version: 2.0
Syntax public static CopyMoveResult Move(
KernelTransaction transaction,
string sourcePath,
string destinationPath,
MoveOptions moveOptions,
CopyMoveProgressRoutine progressHandler,
Object userProgressData,
PathFormat pathFormat
)
Public Shared Function Move (
transaction As KernelTransaction,
sourcePath As String,
destinationPath As String,
moveOptions As MoveOptions,
progressHandler As CopyMoveProgressRoutine,
userProgressData As Object,
pathFormat As PathFormat
) As CopyMoveResult
public:
static CopyMoveResult^ Move(
KernelTransaction^ transaction,
String^ sourcePath,
String^ destinationPath,
MoveOptions moveOptions,
CopyMoveProgressRoutine^ progressHandler,
Object^ userProgressData,
PathFormat pathFormat
)
static member Move :
transaction : KernelTransaction *
sourcePath : string *
destinationPath : string *
moveOptions : MoveOptions *
progressHandler : CopyMoveProgressRoutine *
userProgressData : Object *
pathFormat : PathFormat -> CopyMoveResult
Parameters
- transaction
- Type: Alphaleonis.Win32.FilesystemKernelTransaction
The transaction. - sourcePath
- Type: SystemString
The source directory path. - destinationPath
- Type: SystemString
The destination directory path. - 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:
CopyMoveResultReturns a
CopyMoveResult class with the status of the Move action.
Exceptions Remarks 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