Cmdlet.BeginProcessing Method ()

 

Updated: April 27, 2016

Applies To: Windows PowerShell

Provides a one-time, preprocessing functionality for the cmdlet.

Namespace:   System.Management.Automation
Assembly:  System.Management.Automation (in System.Management.Automation.dll)

protected virtual void BeginProcessing()

Exception Condition
Exception

The override of this method can throw any exception that is required.

This method must be overridden in any cmdlet that does preprocessing. The runspace calls this method once for each instance of the cmdlet in the pipeline.

The override of this method does not have to be reentrant; this method does not have to be callable simultaneously with the ProcessRecord method or the EndProcessing method. None of these input processing methods are called if any one of them is running in a cmdlet instance. However, there is no guarantee that all calls to these methods will occur on the same thread.

For more information about when the Windows PowerShell runtime calls this method, see Cmdlet Lifecycle.

For more information about cmdlets, see Windows PowerShell Cmdlets.

Return to top

Community Additions

ADD
Show: