Cmdlet Members

Serves as a base class for derived cmdlets that do not depend on the Windows PowerShell runtime and that can be called directly from within another cmdlet.

The following tables list the members exposed by the Cmdlet type.

  Name Description
  Cmdlet Creates a new Cmdlet object.
Top
  Name Description
public property CommandOrigin  Gets the origin of the command. The command can be invoked within a runspace or it could be an external request (such as invoking the command from the command line). This property is introduced in Windows PowerShell 2.0. (Inherited from InternalCommand)
public property CommandRuntime Gets and sets the command runtime object that controls what happens when the cmdlet writes an object to the pipeline.
public property static CommonParameters  
public property CurrentPSTransaction Gets the latest transaction started by running the Start-Transaction cmdlet. This property is introduced in Windows PowerShell 2.0.
public property static OptionalCommonParameters  
public property Stopping Gets an indicator that the pipeline is stopping. The pipeline can be stopped for numerous reasons, such as when the user has entered the key combination CTRL+C, a terminating error has occurred, the hosting application requested a stop, and so on.
Top
(see also Protected Methods)
 NameDescription
public methodEquals  (Inherited from Object)
public methodGetHashCode  (Inherited from Object)
public methodGetResourceStringGets a resource string that corresponds to the specified resource base key and identifier.
public methodGetType  (Inherited from Object)
public methodInvokeOverloaded. Invokes a cmdlet object. The variants of this method can invoke a cmdlet that returns a collection of results or a strongly-typed enumerator.
public methodShouldContinueOverloaded. Requests confirmation of an operation from the user. This is typically a second query to the user. The variants of this method can send the query with or without providing yesToall or noToall options to the user.
public methodShouldProcessOverloaded. Requests confirmation from the user before an operation is performed. The variants of this method can be used to send the name of the resource to be changed, send the name of the resource and the operation to be performed, and more. The confirmation message that is displayed to the user is based on which variant of this method is called.
public methodThrowTerminatingErrorReports a terminating error when the cmdlet cannot continue, or when you do not want the cmdlet to continue to process records.
public methodToString  (Inherited from Object)
public methodTransactionAvailableDetermines whether the Start-Transaction cmdlet has been called and that there is a Windows PowerShell transaction available that the cmdlet can participate in. This method is introduced in Windows PowerShell 2.0.
public methodWriteCommandDetailWrites information to the execution log of the pipeline.
public methodWriteDebugWrites a debug message to the host.
public methodWriteErrorReports a nonterminating error to the error pipeline when the cmdlet cannot process a record but can continue to process other records.
public methodWriteObjectOverloaded. Writes an object to the output pipeline. The variants of this method can be used to write a single object or an object that can be enumerated.
public methodWriteProgressWrites a progress record to the host.
public methodWriteVerboseWrites a general user-level message to the pipeline. These messages can help describe what the cmdlet is doing.
public methodWriteWarningWrites a warning message that can be displayed.
Top
  Name Description
protected method BeginProcessing Provides a one-time, preprocessing functionality for the cmdlet.
protected method EndProcessing Provides a one-time, post-processing functionality for the cmdlet.
protected method Finalize  (Inherited from Object)
protected method MemberwiseClone  (Inherited from Object)
protected method ProcessRecord Provides a record-by-record processing functionality for the cmdlet.
protected method StopProcessing Stops processing records when the user stops the cmdlet asynchronously.
Top

Send comments about this topic to Microsoft.
Show:
© 2014 Microsoft. All rights reserved.