ClearItemCommand Class

Definition

Namespace:

Microsoft.PowerShell.Commands

Assembly:

Microsoft.PowerShell.Commands.Management.dll

Package:

Microsoft.PowerShell.Commands.Management v7.4.0

Clears an item at the specified location.

public ref class ClearItemCommand : Microsoft::PowerShell::Commands::CoreCommandWithCredentialsBase

[System.Management.Automation.Cmdlet("Clear", "Item", DefaultParameterSetName="Path", HelpUri="https://go.microsoft.com/fwlink/?LinkID=2096491", SupportsShouldProcess=true, SupportsTransactions=true)]
public class ClearItemCommand : Microsoft.PowerShell.Commands.CoreCommandWithCredentialsBase

[<System.Management.Automation.Cmdlet("Clear", "Item", DefaultParameterSetName="Path", HelpUri="https://go.microsoft.com/fwlink/?LinkID=2096491", SupportsShouldProcess=true, SupportsTransactions=true)>]
type ClearItemCommand = class
    inherit CoreCommandWithCredentialsBase

Public Class ClearItemCommand
Inherits CoreCommandWithCredentialsBase

Inheritance

Object

InternalCommand

Cmdlet

PSCmdlet

CoreCommandBase

CoreCommandWithCredentialsBase

ClearItemCommand

Attributes

CmdletAttribute

Constructors

ClearItemCommand()

Properties

CommandOrigin	This property tells you if you were being invoked inside the runspace or if it was an external request. (Inherited from InternalCommand)
CommandRuntime	Holds the command runtime object for this command. This object controls what actually happens when a write is called. (Inherited from Cmdlet)
Credential	Gets or sets the credential parameter. (Inherited from CoreCommandWithCredentialsBase)
CurrentPSTransaction	Gets an object that surfaces the current PowerShell transaction. When this object is disposed, PowerShell resets the active transaction. (Inherited from Cmdlet)
Events	Gets the event manager for the current runspace. (Inherited from PSCmdlet)
Exclude	Gets or sets the exclude property.
Filter	Gets or sets the filter property.
Force	Gets or sets the force property.
Host	Gets the host interaction APIs. (Inherited from PSCmdlet)
Include	Gets or sets the include property.
InvokeCommand	Provides access to utility routines for executing scripts and creating script blocks. (Inherited from PSCmdlet)
InvokeProvider	Gets the instance of the provider interface APIs for the current runspace. (Inherited from PSCmdlet)
JobManager	Manager for JobSourceAdapters registered. (Inherited from PSCmdlet)
JobRepository	Repository for jobs. (Inherited from PSCmdlet)
LiteralPath	Gets or sets the literal path parameter to the command.
MyInvocation	Contains information about the identity of this cmdlet and how it was invoked. (Inherited from PSCmdlet)
PagingParameters	If the cmdlet declares paging support (via SupportsPaging), then PagingParameters property contains arguments of the paging parameters. Otherwise PagingParameters property is null. (Inherited from PSCmdlet)
ParameterSetName	The name of the parameter set in effect. (Inherited from PSCmdlet)
Path	Gets or sets the path property.
ProviderSupportsShouldProcess	Determines if the provider for the specified path supports ShouldProcess.
RetrievedDynamicParameters	The dynamic parameters which have already been retrieved from the provider and bound by the command processor. (Inherited from CoreCommandBase)
SessionState	Gets the instance of session state for the current runspace. (Inherited from PSCmdlet)
Stopping	Is this command stopping? (Inherited from Cmdlet)
SupportsShouldProcess	Determines if the cmdlet and CmdletProvider supports ShouldProcess. (Inherited from CoreCommandBase)

Methods

BeginProcessing()	When overridden in the derived class, performs initialization of command execution. Default implementation in the base class just returns. (Inherited from Cmdlet)
CurrentProviderLocation(String)	(Inherited from PSCmdlet)
DoesProviderSupportShouldProcess(String[])	A helper for derived classes to call to determine if the paths specified are for a provider that supports ShouldProcess. (Inherited from CoreCommandBase)
EndProcessing()	When overridden in the derived class, performs clean-up after the command execution. Default implementation in the base class just returns. (Inherited from Cmdlet)
GetDynamicParameters()	Retrieves the dynamic parameters for the command from the provider. (Inherited from CoreCommandBase)
GetResolvedProviderPathFromPSPath(String, ProviderInfo)	(Inherited from PSCmdlet)
GetResourceString(String, String)	Gets the resource string corresponding to baseName and resourceId from the current assembly. You should override this if you require a different behavior. (Inherited from Cmdlet)
GetUnresolvedProviderPathFromPSPath(String)	(Inherited from PSCmdlet)
GetVariableValue(String, Object)	(Inherited from PSCmdlet)
GetVariableValue(String)	(Inherited from PSCmdlet)
Invoke()	Invoke this cmdlet object returning a collection of results. (Inherited from Cmdlet)
Invoke<T>()	Returns a strongly-typed enumerator for the results of this cmdlet. (Inherited from Cmdlet)
ProcessRecord()	Clears the specified item.
ShouldContinue(String, String, Boolean, Boolean, Boolean)	Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant offers Yes, No, YesToAll and NoToAll. (Inherited from Cmdlet)
ShouldContinue(String, String, Boolean, Boolean)	Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant offers Yes, No, YesToAll and NoToAll. (Inherited from Cmdlet)
ShouldContinue(String, String)	Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant only offers Yes/No, not YesToAll/NoToAll. (Inherited from Cmdlet)
ShouldProcess(String, String, String, ShouldProcessReason)	Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. This variant allows the caller to specify the complete text describing the operation, rather than just the name and action. (Inherited from Cmdlet)
ShouldProcess(String, String, String)	Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. This variant allows the caller to specify the complete text describing the operation, rather than just the name and action. (Inherited from Cmdlet)
ShouldProcess(String, String)	Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. This variant allows the caller to specify text for both the target resource and the action. (Inherited from Cmdlet)
ShouldProcess(String)	Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. (Inherited from Cmdlet)
StopProcessing()	Stops the processing of the provider by using the CmdletProviderContext to tunnel the stop message to the provider instance. (Inherited from CoreCommandBase)
ThrowTerminatingError(ErrorRecord)	Terminate the command and report an error. (Inherited from Cmdlet)
TransactionAvailable()	Returns true if a transaction is available and active. (Inherited from Cmdlet)
WriteCommandDetail(String)	Write text into pipeline execution log. (Inherited from Cmdlet)
WriteDebug(String)	Display debug information. (Inherited from Cmdlet)
WriteError(ErrorRecord)	Internal variant: Writes the specified error to the error pipe. (Inherited from Cmdlet)
WriteInformation(InformationRecord)	Route information to the user or host. (Inherited from Cmdlet)
WriteInformation(Object, String[])	Route information to the user or host. (Inherited from Cmdlet)
WriteObject(Object, Boolean)	Writes one or more objects to the output pipe. If the object is a collection and the enumerateCollection flag is true, the objects in the collection will be written individually. (Inherited from Cmdlet)
WriteObject(Object)	Writes the object to the output pipe. (Inherited from Cmdlet)
WriteProgress(ProgressRecord)	Display progress information. (Inherited from Cmdlet)
WriteVerbose(String)	Display verbose information. (Inherited from Cmdlet)
WriteWarning(String)	Display warning information. (Inherited from Cmdlet)