PowerShell Logo Small


This is the built-in help made by Microsoft for the command 'ForEach-Object', in PowerShell version 5 - as retrieved from Windows version 'Microsoft Windows Server 2012 R2 Standard' PowerShell help files on 2016-06-23.

For PowerShell version 3 and up, where you have Update-Help, this command was run just before creating the web pages from the help files.


Performs an operation against each item in a collection of input objects.


ForEach-Object [-Process] <ScriptBlock[]> [-Begin [<ScriptBlock>]] [-End [<ScriptBlock>]] [-InputObject [<PSObject>]] [-RemainingScripts [<ScriptBlock[]>]] [-Confirm]
[-WhatIf] [<CommonParameters>]
ForEach-Object [-MemberName] <String> [-ArgumentList [<Object[]>]] [-InputObject [<PSObject>]] [-Confirm] [-WhatIf] [<CommonParameters>]

Search powershellhelp.space


The ForEach-Object cmdlet performs an operation on each item in a collection of input objects. The input objects can be piped to the cmdlet or specified by using the
InputObject parameter.

Beginning in Windows PowerShell 3.0, there are two different ways to construct a ForEach-Object command.

Script block. You can use a script block to specify the operation. Within the script block, use the $_ variable to represent the current object. The script block is the
value of the Process parameter. The script block can contain any Windows PowerShell script.

For example, the following command gets the value of the ProcessName property of each process on the computer.

Get-Process | ForEach-Object {$_.ProcessName}

Operation statement. You can also write a operation statement, which is much more like natural language. You can use the operation statement to specify a property value or
call a method. Operation statements were introduced in Windows PowerShell 3.0.

For example, the following command also gets the value of the ProcessName property of each process on the computer.

Get-Process | ForEach-Object ProcessName

When using the script block format, in addition to using the script block that describes the operations that are performed on each input object, you can provide two
additional script blocks. The Begin script block, which is the value of the Begin parameter, runs before the first input object is processed. The End script block, which is
the value of the End parameter, runs after the last input object is processed.



Online Version: http://go.microsoft.com/fwlink/p/?linkid=289582




-------------------------- EXAMPLE 1 --------------------------

PS C:\>30000, 56798, 12432 | ForEach-Object -Process {$_/1024}

This command takes an array of three integers and divides each one of them by 1024.

-------------------------- EXAMPLE 2 --------------------------

PS C:\>Get-ChildItem $pshome | ForEach-Object -Process {if (!$_.PSIsContainer) {$_.Name; $_.Length / 1024; "" }}

This command gets the files and directories in the Windows PowerShell installation directory ($pshome) and passes them to the ForEach-Object cmdlet. If the object is not a
directory (the value of the PSISContainer property is false), the script block gets the name of the file, divides the value of its Length property by 1024, and adds a space
("") to separate it from the next entry.

-------------------------- EXAMPLE 3 --------------------------

PS C:\>$Events = Get-EventLog -LogName System -Newest 1000
PS C:\>$events | ForEach-Object -Begin {Get-Date} -Process {Out-File -Filepath Events.txt -Append -InputObject $_.Message} -End {Get-Date}

This command gets the 1000 most recent events from the System event log and stores them in the $Events variable. It then pipes the events to the ForEach-Object cmdlet.

The Begin parameter displays the current date and time. Next, the Process parameter uses the Out-File cmdlet to create a text file named events.txt and stores the message
property of each of the events in that file. Last, the End parameter is used to display the date and time after all of the processing has completed.

-------------------------- EXAMPLE 4 --------------------------

PS C:\>Get-ItemProperty -Path HKCU:\Network\* | ForEach-Object {Set-ItemProperty -Path $_.PSPath -Name RemotePath -Value $_.RemotePath.ToUpper();}

This command changes the value of the RemotePath registry entry in all of the subkeys under the HKCU:\Network key to uppercase text. You can use this format to change the
form or content of a registry entry value.

Each subkey in the Network key represents a mapped network drive that will reconnect at logon. The RemotePath entry contains the UNC path of the connected drive. For
example, if you map the E: drive to \\Server\Share, there will be an E subkey of HKCU:\Network and the value of the RemotePath registry entry in the E subkey will be

The command uses the Get-ItemProperty cmdlet to get all of the subkeys of the Network key and the Set-ItemProperty cmdlet to change the value of the RemotePath registry
entry in each key. In the Set-ItemProperty command, the path is the value of the PSPath property of the registry key. (This is a property of the Microsoft .NET Framework
object that represents the registry key; it is not a registry entry.) The command uses the ToUpper() method of the RemotePath value, which is a string (REG_SZ).

Because Set-ItemProperty is changing the property of each key, the ForEach-Object cmdlet is required to access the property.

-------------------------- EXAMPLE 5 --------------------------

PS C:\>1, 2, $null, 4 | ForEach-Object {"Hello"}

This example shows the effect of piping the $null automatic variable to the ForEach-Object cmdlet.

Because Windows PowerShell treats null as an explicit placeholder, the ForEach-Object cmdlet generates a value for $null, just as it does for other objects that you pipe to

For more information about the $null automatic variable, see about_Automatic_Variables.

-------------------------- EXAMPLE 6 --------------------------

PS C:\>Get-Module -List | ForEach-Object -MemberName Path
PS C:\>Get-Module -List | Foreach Path

These commands gets the value of the Path property of all installed Windows PowerShell modules. They use the MemberName parameter to specify the Path property of modules.

The second command is equivalent to the first. It uses the Foreach alias of the Foreach-Object cmdlet and omits the name of the MemberName parameter, which is optional.

The ForEach-Object cmdlet is very useful for getting property values, because it gets the value without changing the type, unlike the Format cmdlets or the Select-Object
cmdlet, which change the property value type.

-------------------------- EXAMPLE 7 --------------------------

PS C:\>"Microsoft.PowerShell.Core", "Microsoft.PowerShell.Host" | ForEach-Object {$_.Split(".")}
PS C:\>"Microsoft.PowerShell.Core", "Microsoft.PowerShell.Host" | ForEach-Object -MemberName Split -ArgumentList "."
PS C:\>"Microsoft.PowerShell.Core", "Microsoft.PowerShell.Host" | Foreach Split "."

These commands split two dot-separated module names into their component names. The commands call the Split method of strings. The three commands use different syntax, but
they are equivalent and interchangeable.

The first command uses the traditional syntax, which includes a script block and the current object operator ($_). It uses the dot syntax to specify the method and
parentheses to enclose the delimiter argument.

The second command uses the MemberName parameter to specify the Split method and the ArgumentName parameter to identify the dot (".") as the split delimiter.

The third command uses the Foreach alias of the Foreach-Object cmdlet and omits the names of the MemberName and ArgumentList parameters, which are optional.

The output of these three commands, shown below, is identical.

Split is just one of many useful methods of strings. To see all of the properties and methods of strings, pipe a string to the Get-Member cmdlet.