ItemCmdletProviderIntrinsics.Clear Method
Definition
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
Clear(String) |
Clears the item at the specified path. |
Clear(String[], Boolean, Boolean) |
Clears the item at the specified path. |
Clear(String)
Clears the item at the specified path.
public:
System::Collections::ObjectModel::Collection<System::Management::Automation::PSObject ^> ^ Clear(System::String ^ path);
public System.Collections.ObjectModel.Collection<System.Management.Automation.PSObject> Clear (string path);
member this.Clear : string -> System.Collections.ObjectModel.Collection<System.Management.Automation.PSObject>
Public Function Clear (path As String) As Collection(Of PSObject)
Parameters
- path
- String
The path to the item to clear. It may be a drive or provider-qualified path and may include glob characters.
Returns
The object(s) cleared at the specified path.
Exceptions
If path
is null.
If the path
refers to a provider that could not be found.
If the path
refers to a drive that could not be found.
If path
does not contain glob characters and
could not be found.
If the provider that the path
refers to does
not support this operation.
If the provider threw an exception.
Applies to
Clear(String[], Boolean, Boolean)
Clears the item at the specified path.
public:
System::Collections::ObjectModel::Collection<System::Management::Automation::PSObject ^> ^ Clear(cli::array <System::String ^> ^ path, bool force, bool literalPath);
public System.Collections.ObjectModel.Collection<System.Management.Automation.PSObject> Clear (string[] path, bool force, bool literalPath);
member this.Clear : string[] * bool * bool -> System.Collections.ObjectModel.Collection<System.Management.Automation.PSObject>
Public Function Clear (path As String(), force As Boolean, literalPath As Boolean) As Collection(Of PSObject)
Parameters
- path
- String[]
The path(s) to the item to clear. It may be a drive or provider-qualified path and may include glob characters.
- force
- Boolean
Passed on to providers to force operations.
- literalPath
- Boolean
If true, globbing is not done on paths.
Returns
The object(s) cleared at the specified path.
Exceptions
If path
is null.
If the path
refers to a provider that could not be found.
If the path
refers to a drive that could not be found.
If path
does not contain glob characters and
could not be found.
If the provider that the path
refers to does
not support this operation.
If the provider threw an exception.