Cmdlet Methods

(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.

  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.

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