This is the built-in help made by Microsoft for the command 'ForEach-Object', in PowerShell version 2 - as retrieved from
Windows version 'Microsoft® Windows Vista™ Ultimate ' 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 of a set of input objects.
ForEach-Object [-Process] <ScriptBlock[]> [-Begin <scriptblock>] [-End <scriptblock>] [-InputObject <psobject>] [<CommonParameters>]
The ForEach-Object cmdlet performs an operation on each of a set of input objects. The input objects can be piped to the cmdlet or specified by u
sing the InputObject parameter.
The operation to perform is described within a script block that is provided to the cmdlet as the value of the Process parameter. The script bloc
k can contain any Windows PowerShell script.
Within the script block, the current input object is represented by the $_ variable.
In addition to using the script block that describes the operations to be carried out on each input object, you can provide two additional script
blocks. One, specified as the value of the Begin parameter, runs before the first input object is processed. The other, specified as the value o
f the End parameter, runs after the last input object is processed.
The results of the evaluation of all the script blocks, including the ones specified with Begin and End, are passed down the pipeline.
<
Online version: http://go.microsoft.com/fwlink/?LinkID=113300
<
-------------------------- EXAMPLE 1 --------------------------
C:\PS>30000,56798,12432 | foreach-object -process {$_/1024}
Description
-----------
This command accepts an array of integers, divides each one of them by 1024, and displays the results.
-------------------------- EXAMPLE 2 --------------------------
C:\PS>get-childitem C:\ | foreach-object -process { $_.length / 1024 }
Description
-----------
This command retrieves the files and directories in the root of the C: drive, and it returns and displays the size of each of them. The zeros rep
resent directories in which no file size was available.
-------------------------- EXAMPLE 3 --------------------------
C:\PS>$events = get-eventlog -logname system -newest 1000
C:\PS> $events | foreach-object -begin {get-date} -process {out-file -filepath events.txt -append -inputobject $_.message} -end {get-date}
Description
-----------
This command retrieves the 1000 most recent events from the system log and stores them in the $events variable. It then pipes the events to the F
orEach-Object cmdlet. The Begin parameter displays the current date and time. Next, the Process parameter uses the Out-File cmdlet to create a te
xt 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 --------------------------
C:\PS>get-itemproperty -path hkcu:\Network\* | foreach-object {set-itemproperty -path $_.pspath -name RemotePath -value $_.RemotePath.ToUpper();}
Description
-----------
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 RemotePa
th registry entry in the E subkey will be \\Server\Share.
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. (Th
is is a property of the Microsoft .NET Framework object that represents the registry key; it is not a registry entry.) The command uses the ToUpp
er() 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.