FileSystem.CopyFile Method

Reference

Definition

Namespace:: Microsoft.VisualBasic.FileIO

Assembly:: Microsoft.VisualBasic.Core.dll

Assembly:: Microsoft.VisualBasic.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Copies a file to a new location.

Overloads

CopyFile(String, String)	Copies a file to a new location.
CopyFile(String, String, UIOption)	Copies a file to a new location.
CopyFile(String, String, Boolean)	Copies a file to a new location.
CopyFile(String, String, UIOption, UICancelOption)	Copies a file to a new location.

CopyFile(String, String)

Source:: FileSystem.vb

Source:: FileSystem.vb

Source:: FileSystem.vb

Copies a file to a new location.

public:
 static void CopyFile(System::String ^ sourceFileName, System::String ^ destinationFileName);

public static void CopyFile(string sourceFileName, string destinationFileName);

static member CopyFile : string * string -> unit

Public Shared Sub CopyFile (sourceFileName As String, destinationFileName As String)

Parameters

sourceFileName: String

The file to be copied.

destinationFileName: String

The location to which the file should be copied.

Exceptions

ArgumentException

destinationFileName contains path information.

ArgumentNullException

destinationFileName or sourceFileName is Nothing or an empty string.

FileNotFoundException

The source file is not valid or does not exist.

IOException

A file in the target directory with the same name is in use.

NotSupportedException

A file or directory name in the path contains a colon (:) or is in an invalid format.

PathTooLongException

The path exceeds the system-defined maximum length.

UnauthorizedAccessException

The user does not have required permission.

SecurityException

The user lacks necessary permissions to view the path.

Examples

This example copies the file Test.txt to the directory TestFiles2 without overwriting existing files.

My.Computer.FileSystem.CopyFile( _
    "C:\UserFiles\TestFiles\test.txt", _
    "C:\UserFiles\TestFiles2\test.txt", overwrite:=False)

Replace the file paths with the paths you want to use in your code.

This example copies the file Test.txt to the directory TestFiles2 and renames it NewFile.txt.

My.Computer.FileSystem.CopyFile( _
    "C:\UserFiles\TestFiles\test.txt", _
    "C:\UserFiles\TestFiles2\NewFile.txt", _
    FileIO.UIOption.OnlyErrorDialogs, _
    FileIO.UICancelOption.DoNothing)

Replace the file paths with the paths you want to use in your code.

Remarks

CopyFile does not preserve ACEs (Access Control Entries). The newly created file inherits default ACEs from the directory in which it is created.

The following table lists examples of tasks involving the My.Computer.FileSystem.CopyFile method.

To	See
Copy a file to the same directory.	How to: Create a Copy of a File in the Same Directory in Visual Basic
Copy a file to a different directory.	How to: Create a Copy of a File in a Different Directory in Visual Basic

Applies to

.NET 9 and other versions

Product	Versions
.NET	Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework	2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1

CopyFile(String, String, UIOption)

Source:: FileSystem.vb

Source:: FileSystem.vb

Source:: FileSystem.vb

Copies a file to a new location.

public:
 static void CopyFile(System::String ^ sourceFileName, System::String ^ destinationFileName, Microsoft::VisualBasic::FileIO::UIOption showUI);

public static void CopyFile(string sourceFileName, string destinationFileName, Microsoft.VisualBasic.FileIO.UIOption showUI);

static member CopyFile : string * string * Microsoft.VisualBasic.FileIO.UIOption -> unit

Public Shared Sub CopyFile (sourceFileName As String, destinationFileName As String, showUI As UIOption)

Parameters

sourceFileName: String

The file to be copied.

destinationFileName: String

The location to which the file should be copied.

showUI: UIOption

Whether to visually track the operation's progress. Default is UIOption.OnlyErrorDialogs.

Exceptions

ArgumentException

destinationFileName contains path information.

ArgumentNullException

destinationFileName or sourceFileName is Nothing or an empty string.

FileNotFoundException

The source file is not valid or does not exist.

IOException

The destination file exists and overwrite is set to False.

NotSupportedException

A file or directory name in the path contains a colon (:) or is in an invalid format.

PathTooLongException

The path exceeds the system-defined maximum length.

UnauthorizedAccessException

The user does not have required permission.

SecurityException

The user lacks necessary permissions to view the path.

Examples

This example copies the file Test.txt to the directory TestFiles2 without overwriting existing files.

My.Computer.FileSystem.CopyFile( _
    "C:\UserFiles\TestFiles\test.txt", _
    "C:\UserFiles\TestFiles2\test.txt", overwrite:=False)

Replace the file paths with the paths you want to use in your code.

This example copies the file Test.txt to the directory TestFiles2 and renames it NewFile.txt.

My.Computer.FileSystem.CopyFile( _
    "C:\UserFiles\TestFiles\test.txt", _
    "C:\UserFiles\TestFiles2\NewFile.txt", _
    FileIO.UIOption.OnlyErrorDialogs, _
    FileIO.UICancelOption.DoNothing)

Replace the file paths with the paths you want to use in your code.

Remarks

CopyFile does not preserve ACEs (Access Control Entries). The newly created file inherits default ACEs from the directory in which it is created.

The following table lists examples of tasks involving the My.Computer.FileSystem.CopyFile method.

To	See
Copy a file to the same directory.	How to: Create a Copy of a File in the Same Directory in Visual Basic
Copy a file to a different directory.	How to: Create a Copy of a File in a Different Directory in Visual Basic

Applies to

.NET 9 and other versions

Product	Versions
.NET	Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework	2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1

CopyFile(String, String, Boolean)

Source:: FileSystem.vb

Source:: FileSystem.vb

Source:: FileSystem.vb

Copies a file to a new location.

public:
 static void CopyFile(System::String ^ sourceFileName, System::String ^ destinationFileName, bool overwrite);

public static void CopyFile(string sourceFileName, string destinationFileName, bool overwrite);

static member CopyFile : string * string * bool -> unit

Public Shared Sub CopyFile (sourceFileName As String, destinationFileName As String, overwrite As Boolean)

Parameters

sourceFileName: String

The file to be copied.

destinationFileName: String

The location to which the file should be copied.

overwrite: Boolean

True if existing files should be overwritten; otherwise False. Default is False.

Exceptions

ArgumentException

destinationFileName contains path information.

ArgumentNullException

destinationFileName or sourceFileName is Nothing or an empty string.

FileNotFoundException

The source file is not valid or does not exist.

IOException

The destination file exists and overwrite is set to False.

NotSupportedException

A file or directory name in the path contains a colon (:) or is in an invalid format.

PathTooLongException

The path exceeds the system-defined maximum length.

UnauthorizedAccessException

The user does not have required permission.

SecurityException

The user lacks necessary permissions to view the path.

Examples

This example copies the file Test.txt to the directory TestFiles2 without overwriting existing files.

My.Computer.FileSystem.CopyFile( _
    "C:\UserFiles\TestFiles\test.txt", _
    "C:\UserFiles\TestFiles2\test.txt", overwrite:=False)

Replace the file paths with the paths you want to use in your code.

This example copies the file Test.txt to the directory TestFiles2 and renames it NewFile.txt.

My.Computer.FileSystem.CopyFile( _
    "C:\UserFiles\TestFiles\test.txt", _
    "C:\UserFiles\TestFiles2\NewFile.txt", _
    FileIO.UIOption.OnlyErrorDialogs, _
    FileIO.UICancelOption.DoNothing)

Replace the file paths with the paths you want to use in your code.

Remarks

CopyFile does not preserve ACEs (Access Control Entries). The newly created file inherits default ACEs from the directory in which it is created.

The following table lists examples of tasks involving the My.Computer.FileSystem.CopyFile method.

To	See
Copy a file to the same directory.	How to: Create a Copy of a File in the Same Directory in Visual Basic
Copy a file to a different directory.	How to: Create a Copy of a File in a Different Directory in Visual Basic

Applies to

.NET 9 and other versions

Product	Versions
.NET	Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework	2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1

CopyFile(String, String, UIOption, UICancelOption)

Source:: FileSystem.vb

Source:: FileSystem.vb

Source:: FileSystem.vb

Copies a file to a new location.

public:
 static void CopyFile(System::String ^ sourceFileName, System::String ^ destinationFileName, Microsoft::VisualBasic::FileIO::UIOption showUI, Microsoft::VisualBasic::FileIO::UICancelOption onUserCancel);

public static void CopyFile(string sourceFileName, string destinationFileName, Microsoft.VisualBasic.FileIO.UIOption showUI, Microsoft.VisualBasic.FileIO.UICancelOption onUserCancel);

static member CopyFile : string * string * Microsoft.VisualBasic.FileIO.UIOption * Microsoft.VisualBasic.FileIO.UICancelOption -> unit

Public Shared Sub CopyFile (sourceFileName As String, destinationFileName As String, showUI As UIOption, onUserCancel As UICancelOption)

Parameters

sourceFileName: String

The file to be copied.

destinationFileName: String

The location to which the file should be copied.

showUI: UIOption

Whether to visually track the operation's progress. Default is UIOption.OnlyErrorDialogs.

onUserCancel: UICancelOption

Specifies what should be done if the user clicks Cancel during the operation. Default is ThrowException.

Exceptions

ArgumentException

destinationFileName contains path information.

ArgumentNullException

destinationFileName or sourceFileName is Nothing or an empty string.

FileNotFoundException

The source file is not valid or does not exist.

IOException

The destination file exists and overwrite is set to False.

NotSupportedException

A file or directory name in the path contains a colon (:) or is in an invalid format.

PathTooLongException

The path exceeds the system-defined maximum length.

UnauthorizedAccessException

The user does not have required permission.

SecurityException

The user lacks necessary permissions to view the path.

OperationCanceledException

UICancelOption is set to ThrowException, and the user has canceled the operation or an unspecified I/O error occurs.

Examples

This example copies the file Test.txt to the directory TestFiles2 without overwriting existing files.

My.Computer.FileSystem.CopyFile( _
    "C:\UserFiles\TestFiles\test.txt", _
    "C:\UserFiles\TestFiles2\test.txt", overwrite:=False)

Replace the file paths with the paths you want to use in your code.

This example copies the file Test.txt to the directory TestFiles2 and renames it NewFile.txt.

My.Computer.FileSystem.CopyFile( _
    "C:\UserFiles\TestFiles\test.txt", _
    "C:\UserFiles\TestFiles2\NewFile.txt", _
    FileIO.UIOption.OnlyErrorDialogs, _
    FileIO.UICancelOption.DoNothing)

Replace the file paths with the paths you want to use in your code.

Remarks

CopyFile does not preserve ACEs (Access Control Entries). The newly created file inherits default ACEs from the directory in which it is created.

The following table lists examples of tasks involving the My.Computer.FileSystem.CopyFile method.

To	See
Copy a file to the same directory.	How to: Create a Copy of a File in the Same Directory in Visual Basic
Copy a file to a different directory.	How to: Create a Copy of a File in a Different Directory in Visual Basic

Applies to

.NET 9 and other versions

Product	Versions
.NET	Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework	2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1

Share via

FileSystem.CopyFile Method

Definition

Overloads

CopyFile(String, String)

Parameters

Exceptions

Examples

Remarks

See also

Applies to

CopyFile(String, String, UIOption)

Parameters

Exceptions

Examples

Remarks

See also

Applies to

CopyFile(String, String, Boolean)

Parameters

Exceptions

Examples

Remarks

See also

Applies to

CopyFile(String, String, UIOption, UICancelOption)

Parameters

Exceptions

Examples

Remarks

See also

Applies to

Additional resources