DirectoryInfo.CopyTo Method (String, CopyOptions, CopyMoveProgressRoutine, Object, PathFormat)

DirectoryInfoCopyTo Method (String, CopyOptions, CopyMoveProgressRoutine, Object, PathFormat)

[AlphaFS] Copies an existing directory to a new directory, allowing the overwriting of an existing directory, CopyOptions 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

C++

Copy

public CopyMoveResult CopyTo(
	string destinationPath,
	CopyOptions copyOptions,
	CopyMoveProgressRoutine progressHandler,
	Object userProgressData,
	PathFormat pathFormat
)

Public Function CopyTo ( 
	destinationPath As String,
	copyOptions As CopyOptions,
	progressHandler As CopyMoveProgressRoutine,
	userProgressData As Object,
	pathFormat As PathFormat
) As CopyMoveResult

public:
CopyMoveResult^ CopyTo(
	String^ destinationPath, 
	CopyOptions copyOptions, 
	CopyMoveProgressRoutine^ progressHandler, 
	Object^ userProgressData, 
	PathFormat pathFormat
)

member CopyTo : 
        destinationPath : string * 
        copyOptions : CopyOptions * 
        progressHandler : CopyMoveProgressRoutine * 
        userProgressData : Object * 
        pathFormat : PathFormat -> CopyMoveResult

Parameters

destinationPath: Type: SystemString
The destination directory path.
copyOptions: Type: Alphaleonis.Win32.FilesystemCopyOptions
CopyOptions that specify how the directory is to be copied. This parameter can be .
progressHandler: Type: Alphaleonis.Win32.FilesystemCopyMoveProgressRoutine
A callback function that is called each time another portion of the directory has been copied. 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 Copy action.

Returns a new directory, or an overwrite of an existing directory if copyOptions is not FailIfExists.

If the directory exists and copyOptions contains FailIfExists, an IOException is thrown.

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.
IOException	Passed when an I/O error occurs.
NotSupportedException
UnauthorizedAccessException

Remarks

Option NoBuffering is recommended for very large file transfers.

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

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.

Reference

DirectoryInfo Class

CopyTo Overload

Alphaleonis.Win32.Filesystem Namespace