ItemCmdletProviderIntrinsics.Remove 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

Remove(String, Boolean)	Removes the items at the given path.
Remove(String[], Boolean, Boolean, Boolean)	Removes the items at the given path.

Remove(String, Boolean)

Removes the items at the given path.

public:
 void Remove(System::String ^ path, bool recurse);

public:
 void Remove(Platform::String ^ path, bool recurse);

void Remove(std::wstring const & path, bool recurse);

public void Remove (string path, bool recurse);

member this.Remove : string * bool -> unit

Public Sub Remove (path As String, recurse As Boolean)

Parameters

path: String

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

recurse: Boolean

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

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

Remove(String[], Boolean, Boolean, Boolean)

Removes the items at the given path.

public:
 void Remove(cli::array <System::String ^> ^ path, bool recurse, bool force, bool literalPath);

public:
 void Remove(Platform::Array <Platform::String ^> ^ path, bool recurse, bool force, bool literalPath);

void Remove(std::Array <std::wstring const &> const & path, bool recurse, bool force, bool literalPath);

public void Remove (string[] path, bool recurse, bool force, bool literalPath);

member this.Remove : string[] * bool * bool * bool -> unit

Public Sub Remove (path As String(), recurse As Boolean, force As Boolean, literalPath As Boolean)

Parameters

path: String[]

The path(s) to the item(s) to remove. They may be drive or provider-qualified paths and may include glob characters.

recurse: Boolean

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