ItemCmdletProviderIntrinsics.Copy Method

Reference

Definition

Namespace:: System.Management.Automation

Assembly:: System.Management.Automation.dll

Package:: Microsoft.PowerShell.5.1.ReferenceAssemblies v1.0.0

Package:: System.Management.Automation v7.0.13

Package:: System.Management.Automation v7.1.7

Package:: System.Management.Automation v7.2.12

Package:: System.Management.Automation v7.3.5

Package:: System.Management.Automation v7.4.0

Package:: Microsoft.WSMan.Runtime v6.1.0

Package:: Microsoft.WSMan.Runtime v6.2.0

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.

Overloads

Copy(String, String, Boolean, CopyContainers)	Copy item at the specified path.
Copy(String[], String, Boolean, CopyContainers, Boolean, Boolean)	Copy item at the specified path.

Copy(String, String, Boolean, CopyContainers)

Copy item at the specified path.

public:
 System::Collections::ObjectModel::Collection<System::Management::Automation::PSObject ^> ^ Copy(System::String ^ path, System::String ^ destinationPath, bool recurse, System::Management::Automation::CopyContainers copyContainers);

public System.Collections.ObjectModel.Collection<System.Management.Automation.PSObject> Copy (string path, string destinationPath, bool recurse, System.Management.Automation.CopyContainers copyContainers);

member this.Copy : string * string * bool * System.Management.Automation.CopyContainers -> System.Collections.ObjectModel.Collection<System.Management.Automation.PSObject>

Public Function Copy (path As String, destinationPath As String, recurse As Boolean, copyContainers As CopyContainers) As Collection(Of PSObject)

Parameters

path: String

The path to the item to copy. It may be a drive or provider-qualified path and may include glob characters.

destinationPath: String

The path to copy the item to.

recurse: Boolean

If true, copies all the children in all the sub-containers of the specified container. If false, only copies the specified item.

copyContainers: CopyContainers

Determines how the source container is used in the copy operation.

Returns

Collection<PSObject>

The item(s) that were copied.

Exceptions

ArgumentNullException

If path is null.

ProviderNotFoundException

If the path refers to a provider that could not be found.

DriveNotFoundException

If the path refers to a drive that could not be found.

ItemNotFoundException

If path does not contain glob characters and could not be found.

NotSupportedException

If the provider that the path refers to does not support this operation.

ProviderInvocationException

If the provider threw an exception.

Applies to

Copy(String[], String, Boolean, CopyContainers, Boolean, Boolean)

Copy item at the specified path.

public:
 System::Collections::ObjectModel::Collection<System::Management::Automation::PSObject ^> ^ Copy(cli::array <System::String ^> ^ path, System::String ^ destinationPath, bool recurse, System::Management::Automation::CopyContainers copyContainers, bool force, bool literalPath);

public System.Collections.ObjectModel.Collection<System.Management.Automation.PSObject> Copy (string[] path, string destinationPath, bool recurse, System.Management.Automation.CopyContainers copyContainers, bool force, bool literalPath);

member this.Copy : string[] * string * bool * System.Management.Automation.CopyContainers * bool * bool -> System.Collections.ObjectModel.Collection<System.Management.Automation.PSObject>

Public Function Copy (path As String(), destinationPath As String, recurse As Boolean, copyContainers As CopyContainers, force As Boolean, literalPath As Boolean) As Collection(Of PSObject)