FileCopyTransacted Method (KernelTransaction, String, String, CopyOptions, CopyMoveProgressRoutine, Object) |
[AlphaFS] Copies an existing file to a new file. Overwriting a file of the same name is allowed.
CopyOptions can be specified,
and the possibility of notifying the application of its progress through a callback function.
Remarks Option NoBuffering is recommended for very large file transfers.
The attributes of the original file are retained in the copied 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.
Namespace:
Alphaleonis.Win32.Filesystem
Assembly:
AlphaFS (in AlphaFS.dll) Version: 2.2
Syntax public static CopyMoveResult CopyTransacted(
KernelTransaction transaction,
string sourcePath,
string destinationPath,
CopyOptions copyOptions,
CopyMoveProgressRoutine progressHandler,
Object userProgressData
)
Public Shared Function CopyTransacted (
transaction As KernelTransaction,
sourcePath As String,
destinationPath As String,
copyOptions As CopyOptions,
progressHandler As CopyMoveProgressRoutine,
userProgressData As Object
) As CopyMoveResult
public:
static CopyMoveResult^ CopyTransacted(
KernelTransaction^ transaction,
String^ sourcePath,
String^ destinationPath,
CopyOptions copyOptions,
CopyMoveProgressRoutine^ progressHandler,
Object^ userProgressData
)
static member CopyTransacted :
transaction : KernelTransaction *
sourcePath : string *
destinationPath : string *
copyOptions : CopyOptions *
progressHandler : CopyMoveProgressRoutine *
userProgressData : Object -> CopyMoveResult
Parameters
- transaction
- Type: Alphaleonis.Win32.FilesystemKernelTransaction
The transaction. - sourcePath
- Type: SystemString
The file to copy. - destinationPath
- Type: SystemString
The name of the destination file. This cannot be a directory. - copyOptions
- Type: Alphaleonis.Win32.FilesystemCopyOptions
CopyOptions that specify how the file 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 file has been copied. This parameter can be . - userProgressData
- Type: SystemObject
The argument to be passed to the callback function. This parameter can be .
Return Value
Type:
CopyMoveResultA
CopyMoveResult class with details of the Copy action.
Exceptions See Also