Cmdlet.ProcessRecord Method
Provides a record-by-record processing functionality for the cmdlet.


Namespace: System.Management.Automation
Assembly: System.Management.Automation (in system.management.automation.dll)
Usage

Me.ProcessRecord
Syntax

Visual Basic
Protected Overridable Sub ProcessRecord
C#
protected virtual void ProcessRecord ()
C++
protected:
virtual void ProcessRecord ()
J#
protected void ProcessRecord ()
JScript
protected function ProcessRecord ()
Exceptions

Exception typeCondition
Exception

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

Remarks

This method must be overridden in any cmdlet that does more than preprocessing or post-processing. The Windows PowerShell runtime calls this method multiple times 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 BeginProcessing method or the EndProcessing method. None of these input processing methods are called if any one of them is running for a cmdlet instance. However, there is no guarantee that all calls to these methods will occur on the same thread.

This method must be overridden if a cmdlet parameter is defined as accepting ValueFromPipeline or ValueFromPipelineByPropertyName. If this method is not overridden, the cmdlet will not receive the pipelined values that are passed to the cmdlet. For more information about defining parameters, see >ParameterAttribute Declaration.

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

For more information about cmdlets, see >Windows PowerShell Cmdlets.


Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Platforms

Development Platforms

Windows Server 2008, Windows Vista, Windows Server 2003, Windows XP, Windows 7, Windows 2008 R2

Target Platforms

Windows Server 2008, Windows Server 2003, Windows Vista, Windows XP, Windows 7, Windows 2008 R2
See Also

Page view tracker