Share via

IContentCmdletProvider.ClearContent(String) Method

  • Reference

Definition

Namespace:
System.Management.Automation.Provider
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

Clears the content from the specified item.

public:
 void ClearContent(System::String ^ path);
public:
 void ClearContent(Platform::String ^ path);
void ClearContent(std::wstring const & path);
public void ClearContent (string path);
abstract member ClearContent : string -> unit
Public Sub ClearContent (path As String)

Parameters

path
String

The path to the item to clear the content from.

Remarks

Overrides of this method should remove any content from the object but not remove (delete) the object itself.

Providers that declare ProviderCapabilities of ExpandWildcards, Filter, Include, or Exclude should ensure that the path passed meets those requirements by accessing the appropriate property from the base class.

By default overrides of this method should not clear or write objects that are generally hidden from the user unless the Force property is set to true. An error should be sent to the WriteError method if the path represents an item that is hidden from the user and Force is set to false.

Applies to