FileCopyTransacted Method (KernelTransaction, String, String, CopyOptions, CopyMoveProgressRoutine, Object, PathFormat) |
[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.
Namespace:
Alphaleonis.Win32.Filesystem
Assembly:
AlphaFS (in AlphaFS.dll) Version: 2.0
Syntax public static CopyMoveResult CopyTransacted(
KernelTransaction transaction,
string sourceFileName,
string destinationFileName,
CopyOptions copyOptions,
CopyMoveProgressRoutine progressHandler,
Object userProgressData,
PathFormat pathFormat
)
Public Shared Function CopyTransacted (
transaction As KernelTransaction,
sourceFileName As String,
destinationFileName As String,
copyOptions As CopyOptions,
progressHandler As CopyMoveProgressRoutine,
userProgressData As Object,
pathFormat As PathFormat
) As CopyMoveResult
public:
static CopyMoveResult^ CopyTransacted(
KernelTransaction^ transaction,
String^ sourceFileName,
String^ destinationFileName,
CopyOptions copyOptions,
CopyMoveProgressRoutine^ progressHandler,
Object^ userProgressData,
PathFormat pathFormat
)
static member CopyTransacted :
transaction : KernelTransaction *
sourceFileName : string *
destinationFileName : string *
copyOptions : CopyOptions *
progressHandler : CopyMoveProgressRoutine *
userProgressData : Object *
pathFormat : PathFormat -> CopyMoveResult
Parameters
- transaction
- Type: Alphaleonis.Win32.FilesystemKernelTransaction
The transaction. - sourceFileName
- Type: SystemString
The file to copy. - destinationFileName
- 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 . - pathFormat
- Type: Alphaleonis.Win32.FilesystemPathFormat
Indicates the format of the path parameter(s).
Return Value
Type:
CopyMoveResultA
CopyMoveResult class with the status of the Copy action.
Exceptions 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.
See Also