CopyTo Method (IWritableFileInfo)

Copies an existing file to a new file, optionally allowing the overwriting of an existing file.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<NotNullAttribute()>
Function CopyTo( _
   ByVal destinationFilePathAndName As String, _
   ByVal overwrite As Boolean _
) As IWritableFileInfo

'Usage
 
Dim instance As IWritableFileInfo
Dim destinationFilePathAndName As String
Dim overwrite As Boolean
Dim value As IWritableFileInfo
 
value = instance.CopyTo(destinationFilePathAndName, overwrite)

[NotNull()]
IWritableFileInfo CopyTo( 
   string destinationFilePathAndName,
   bool overwrite
)

[NotNull()]
IWritableFileInfo^ CopyTo( 
   String^ destinationFilePathAndName,
   bool overwrite
)

Parameters

destinationFilePathAndName: The name of the file to copy to.
The value of this parameter cannot be null (Nothing in Visual Basic).
overwrite: true to allow an existing file to be overwritten; otherwise, false.

Return Value

This method never returns null (Nothing in Visual Basic).

Exceptions

Exception	Description
System.ArgumentException	One of the arguments provided to a method is not valid. This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.
System.ArgumentNullException	A `null` reference (`Nothing` in Visual Basic) is passed to a method that does not accept it as a valid argument. This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.
System.IO.DirectoryNotFoundException	Part of a file or directory cannot be found. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.
System.IO.FileNotFoundException	An attempt to access a file that does not exist on disk has failed. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.
System.IO.IOException	An I/O error has occurred. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.
System.NotSupportedException	An invoked method is not supported at all, or is not supported with the parameters used to create the object.
System.IO.PathTooLongException	A path or fully qualified file name is longer than the system-defined maximum length. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.
System.Security.SecurityException	A security error was detected. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.
System.UnauthorizedAccessException	The operating system has denied access because of an I/O error or a specific type of security error. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.

Remarks

This method is similar in purpose to System.IO.FileInfo.CopyTo(System.String,System.Boolean), but is generalized for any kind of writable file info, not just files in the physical file system.

Use this method to allow or prevent overwriting of an existing file. Use the OpcLabs.BaseLib.Extensions.FileProviders.IWritableFileInfoExtension.CopyTo(OpcLabs.BaseLib.Extensions.FileProviders.IWritableFileInfo,System.String) method to prevent overwriting of an existing file by default.

This method can be used with an absolute path pointing in destinationFilePathAndName.

For Microsoft.Extensions.FileProviders.IFileInfo, IFileInfo2 and IWritableFileInfo, relative paths are based on the directory where the file is located; absolute paths are based on the root directory of the file provider.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

Reference

IWritableFileInfo Interface
IWritableFileInfo Members
OpcLabs.BaseLib.Extensions.FileProviders.IWritableFileInfoExtension.CopyTo(OpcLabs.BaseLib.Extensions.FileProviders.IWritableFileInfo,System.String)
MoveTo Method

Documentation Home, Send Documentation Feedback. Technical Support