FileSystemProxy.CopyFile Method

Definition

Namespace:

Microsoft.VisualBasic.MyServices

Assembly:

Microsoft.VisualBasic.Forms.dll

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)

Copies a file to a new location.

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

public void CopyFile (string sourceFileName, string destinationFileName);

member this.CopyFile : string * string -> unit

Public 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
Copy a file to a different directory.	How to: Create a Copy of a File in a Different Directory

See also

• UICancelOption
• Objects (Visual Basic)
• How to: Copy Files with a Specific Pattern to a Directory in Visual Basic
• How to: Create a Copy of a File in the Same Directory in Visual Basic
• How to: Copy a Directory to Another Directory in Visual Basic
• How to: Rename a File in Visual Basic

CopyFile(String, String, UIOption)

Copies a file to a new location.

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

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

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

Public 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
Copy a file to a different directory.	How to: Create a Copy of a File in a Different Directory

See also

• UICancelOption
• Objects (Visual Basic)
• How to: Copy Files with a Specific Pattern to a Directory in Visual Basic
• How to: Create a Copy of a File in the Same Directory in Visual Basic
• How to: Copy a Directory to Another Directory in Visual Basic
• How to: Rename a File in Visual Basic

CopyFile(String, String, Boolean)

Copies a file to a new location.

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

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

member this.CopyFile : string * string * bool -> unit

Public 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
Copy a file to a different directory.	How to: Create a Copy of a File in a Different Directory

See also

• UICancelOption
• Objects (Visual Basic)
• How to: Copy Files with a Specific Pattern to a Directory in Visual Basic
• How to: Create a Copy of a File in the Same Directory in Visual Basic
• How to: Copy a Directory to Another Directory in Visual Basic
• How to: Rename a File in Visual Basic

CopyFile(String, String, UIOption, UICancelOption)

Copies a file to a new location.

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

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

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

Public 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
Copy a file to a different directory.	How to: Create a Copy of a File in a Different Directory

See also

• UICancelOption
• Objects (Visual Basic)
• How to: Copy Files with a Specific Pattern to a Directory in Visual Basic
• How to: Create a Copy of a File in the Same Directory in Visual Basic
• How to: Copy a Directory to Another Directory in Visual Basic
• How to: Rename a File in Visual Basic