ForEach-Object
Provede operaci s každou položkou v kolekci vstupních objektů.
Syntaxe
ForEach-Object
[-InputObject <PSObject>]
[-Begin <ScriptBlock>]
[-Process] <ScriptBlock[]>
[-End <ScriptBlock>]
[-RemainingScripts <ScriptBlock[]>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ForEach-Object
[-InputObject <PSObject>]
[-MemberName] <String>
[-ArgumentList <Object[]>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Rutina ForEach-Object
provádí operaci pro každou položku v kolekci vstupních objektů. Vstupní objekty lze předvést do rutiny nebo zadat pomocí parametru InputObject .
Počínaje windows PowerShellem 3.0 existují dva různé způsoby vytvoření ForEach-Object
příkazu.
Blok skriptu. K určení operace můžete použít blok skriptu. V rámci bloku skriptu použijte
$_
proměnnou k reprezentaci aktuálního objektu. Blok skriptu je hodnota parametru Process . Blok skriptu může obsahovat libovolný skript PowerShellu.Například následující příkaz získá hodnotu ProcessName vlastnost každého procesu v počítači.
Get-Process | ForEach-Object {$_.ProcessName}
ForEach-Object
begin
podporuje ,process
aend
bloky, jak je popsáno v about_functions.Poznámka:
Bloky skriptu se spouštějí v oboru volajícího. Bloky proto mají přístup k proměnným v daném oboru a můžou vytvářet nové proměnné, které se v daném oboru zachovají po dokončení rutiny.
Příkaz Operation. Můžete také napsat příkaz operace, což je mnohem více jako přirozený jazyk. Příkaz operace můžete použít k určení hodnoty vlastnosti nebo volání metody. Příkazy operací byly zavedeny ve Windows PowerShellu 3.0.
Například následující příkaz také získá hodnotu ProcessName vlastnost každého procesu v počítači.
Get-Process | ForEach-Object ProcessName
Příklady
Příklad 1: Dělení celých čísel v matici
V tomto příkladu se používá pole se třemi celými čísly a každý z nich vydělí číslem 1024.
30000, 56798, 12432 | ForEach-Object -Process {$_/1024}
29.296875
55.466796875
12.140625
Příklad 2: Získání délky všech souborů v adresáři
Tento příklad zpracovává soubory a adresáře v instalačním adresáři $PSHOME
PowerShellu .
Get-ChildItem $PSHOME |
ForEach-Object -Process {if (!$_.PSIsContainer) {$_.Name; $_.Length / 1024; " " }}
Pokud objekt není adresář, blok skriptu získá název souboru, vydělí hodnotu jeho vlastnosti Length hodnotou 1024 a přidá mezeru (" ") k jeho oddělení od další položky. Rutina používá vlastnost PSISContainer k určení, zda je objekt adresáře.
Příklad 3: Operace s nejnovějšími událostmi systému
Tento příklad zapíše 1000 nejnovějších událostí z protokolu událostí systému do textového souboru. Aktuální čas se zobrazí před a po zpracování událostí.
Get-EventLog -LogName System -Newest 1000 |
ForEach-Object -Begin {Get-Date} -Process {
Out-File -FilePath Events.txt -Append -InputObject $_.Message
} -End {Get-Date}
Get-EventLog
získá 1000 nejnovějších událostí z protokolu událostí systému a předá je do rutiny ForEach-Object
. Parametr Begin zobrazuje aktuální datum a čas. Parametr Process dále pomocí rutiny Out-File
vytvoří textový soubor s názvem events.txt a uloží vlastnost zprávy jednotlivých událostí v daném souboru. Nakonec se parametr End použije k zobrazení data a času po dokončení veškerého zpracování.
Příklad 4: Změna hodnoty klíče registru
Tento příklad změní hodnotu položky registru RemotePath ve všech podklíčích pod HKCU:\Network
klíčem na velká písmena textu.
Get-ItemProperty -Path HKCU:\Network\* |
ForEach-Object {
Set-ItemProperty -Path $_.PSPath -Name RemotePath -Value $_.RemotePath.ToUpper()
}
Tento formát můžete použít ke změně formuláře nebo obsahu hodnoty položky registru.
Každý podklíč v síťovém klíči představuje namapovanou síťovou jednotku, která se znovu připojí při přihlášení. Položka RemotePath obsahuje cestu UNC připojené jednotky. Pokud například namapujete jednotku E:
na \\Server\Share
podklíč E, vytvoří se podklíč HKCU:\Network
E s hodnotou registru RemotePath nastavenou na \\Server\Share
hodnotu .
Příkaz pomocí rutiny Get-ItemProperty
získá všechny podklíče síťového klíče a rutiny Set-ItemProperty
ke změně hodnoty položky registru RemotePath v každém klíči. Set-ItemProperty
V příkazu je cesta hodnotou vlastnosti PSPath klíče registru. Toto je vlastnost objektu rozhraní Microsoft .NET Framework, který představuje klíč registru, nikoli položku registru. Příkaz používá metodu ToUpper() hodnoty RemotePath, což je řetězec REG_SZ.
Vzhledem k tomu Set-ItemProperty
, že se mění vlastnost každého klíče, ForEach-Object
je rutina nutná pro přístup k této vlastnosti.
Příklad 5: Použití $null automatické proměnné
Tento příklad ukazuje účinek propojení $null
automatické proměnné do rutiny ForEach-Object
.
1, 2, $null, 4 | ForEach-Object {"Hello"}
Hello
Hello
Hello
Hello
Vzhledem k tomu, že PowerShell považuje $null
za explicitní zástupný symbol, rutina vygeneruje hodnotu tak$null
, ForEach-Object
jak to dělá pro ostatní objekty předané do něj.
Příklad 6: Získání hodnot vlastností
Tento příklad získá hodnotu Path vlastnost všech nainstalovaných modulů PowerShellu pomocí parametru MemberName rutiny ForEach-Object
.
Get-Module -ListAvailable | ForEach-Object -MemberName Path
Get-Module -ListAvailable | Foreach Path
Druhý příkaz je ekvivalentní prvnímu příkazu. Používá Foreach
alias ForEach-Object
rutiny a vynechá název parametru MemberName , který je volitelný.
Rutina ForEach-Object
je užitečná pro získání hodnot vlastností, protože získá hodnotu beze změny typu, na rozdíl od rutin Format nebo rutiny Select-Object
, která změní typ hodnoty vlastnosti.
Příklad 7: Rozdělení názvů modulů na názvy komponent
Tento příklad ukazuje tři způsoby rozdělení dvou názvů modulů oddělených tečkami na názvy komponent. Příkazy volají metodu Split řetězců. Tyto tři příkazy používají jinou syntaxi, ale jsou ekvivalentní a zaměnitelné. Výstup je stejný pro všechny tři případy.
"Microsoft.PowerShell.Core", "Microsoft.PowerShell.Host" |
ForEach-Object {$_.Split(".")}
"Microsoft.PowerShell.Core", "Microsoft.PowerShell.Host" |
ForEach-Object -MemberName Split -ArgumentList "."
"Microsoft.PowerShell.Core", "Microsoft.PowerShell.Host" |
Foreach Split "."
Microsoft
PowerShell
Core
Microsoft
PowerShell
Host
První příkaz používá tradiční syntaxi, která zahrnuje blok skriptu a aktuální operátor $_
objektu . Pomocí syntaxe tečky určuje metodu a závorky k uzavření argumentu oddělovače.
Druhý příkaz používá parametr MemberName k určení Split metoda a ArgumentList parametr identifikovat tečku (.
) jako oddělovač rozdělení.
Třetí příkaz používá alias ForEach-Object
Foreach rutiny a vynechá názvy parametrů MemberName a ArgumentList, které jsou volitelné.
Příklad 8: Použití objektu ForEach se dvěma bloky skriptu
V tomto příkladu předáme dva bloky skriptu pozičním způsobem. Všechny bloky skriptu se sváže s parametrem Process . Považují se však za to, že byly předány parametrům Begin a Process .
1..2 | ForEach-Object { 'begin' } { 'process' }
begin
process
process
Příklad 9: Použití objektu ForEach s více než dvěma bloky skriptu
V tomto příkladu předáváme pozičním způsobem čtyři bloky skriptu. Všechny bloky skriptu se sváže s parametrem Process . Považují se však za to, že byly předány parametrům Begin, Process a End .
1..2 | ForEach-Object { 'begin' } { 'process A' } { 'process B' } { 'end' }
begin
process A
process B
process A
process B
end
Poznámka:
První blok skriptu se vždy mapuje na begin
blok, poslední blok se mapuje na end
blok a dva prostřední bloky se mapují na process
blok.
Příklad 10: Spuštění více bloků skriptů pro každou položku kanálu
Jak je znázorněno v předchozím příkladu, několik bloků skriptu předaných pomocí parametru Process se mapuje na parametry Begin a End . Chcete-li se tomuto mapování vyhnout, je nutné zadat explicitní hodnoty parametrů Begin a End .
1..2 | ForEach-Object -Begin $null -Process { 'one' }, { 'two' }, { 'three' } -End $null
one
two
three
one
two
three
Parametry
-ArgumentList
Určuje pole argumentů pro volání metody. Další informace o chování ArgumentList naleznete v tématu about_Splatting.
Tento parametr byl představen ve Windows PowerShellu 3.0.
Typ: | Object[] |
Aliasy: | Args |
Position: | Named |
Default value: | None |
Vyžadováno: | False |
Přijmout vstup kanálu: | False |
Přijmout zástupné znaky: | False |
-Begin
Určuje blok skriptu, který se spustí před tím, než tato rutina zpracuje všechny vstupní objekty. Tento blok skriptu se spustí pouze jednou pro celý kanál. Další informace o begin
bloku najdete v tématu about_Functions.
Typ: | ScriptBlock |
Position: | Named |
Default value: | None |
Vyžadováno: | False |
Přijmout vstup kanálu: | False |
Přijmout zástupné znaky: | False |
-Confirm
Před spuštěním rutiny zobrazí výzvu k potvrzení.
Typ: | SwitchParameter |
Aliasy: | cf |
Position: | Named |
Default value: | False |
Vyžadováno: | False |
Přijmout vstup kanálu: | False |
Přijmout zástupné znaky: | False |
-End
Určuje blok skriptu, který se spustí po této rutině, zpracuje všechny vstupní objekty. Tento blok skriptu se spustí pouze jednou pro celý kanál. Další informace o end
bloku najdete v tématu about_Functions.
Typ: | ScriptBlock |
Position: | Named |
Default value: | None |
Vyžadováno: | False |
Přijmout vstup kanálu: | False |
Přijmout zástupné znaky: | False |
-InputObject
Určuje vstupní objekty. ForEach-Object
spustí příkaz bloku skriptu nebo operace na každém vstupním objektu. Zadejte proměnnou, která obsahuje objekty, nebo zadejte příkaz nebo výraz, který objekty získá.
Pokud použijete inputObject parametr s ForEach-Object
, místo piping command výsledky do ForEach-Object
, InputObject hodnota je považována za jeden objekt. To platí i v případě, že hodnota je kolekce, která je výsledkem příkazu, například -InputObject (Get-Process)
.
Vzhledem k tomu , že InputObject nemůže vracet jednotlivé vlastnosti z pole nebo kolekce objektů, doporučujeme, abyste v případě ForEach-Object
použití k provádění operací s kolekcí objektů pro tyto objekty, které mají určité hodnoty v definovaných vlastnostech, použijete ForEach-Object
v kanálu, jak je znázorněno v příkladech v tomto tématu.
Typ: | PSObject |
Position: | Named |
Default value: | None |
Vyžadováno: | False |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | False |
-MemberName
Určuje název vlastnosti člena pro získání nebo metodu člena volání. Členy musí být členy instance, nikoli statické členy.
Jsou povoleny zástupné znaky, ale fungují pouze v případě, že se výsledný řetězec přeloží na jedinečnou hodnotu.
Pokud například spustíte Get-Process | ForEach -MemberName *Name
příkaz, vzor se zástupným znakem odpovídá více než jednomu členu, což způsobí selhání příkazu.
Tento parametr byl představen ve Windows PowerShellu 3.0.
Typ: | String |
Position: | 0 |
Default value: | None |
Vyžadováno: | True |
Přijmout vstup kanálu: | False |
Přijmout zástupné znaky: | True |
-Process
Určuje operaci, která se provádí u každého vstupního objektu. Tento blok skriptu se spouští pro každý objekt v kanálu. Další informace o process
bloku najdete v tématu about_Functions.
Pokud do parametru Process zadáte více bloků skriptu, první blok skriptu se vždy mapuje na begin
blok. Pokud existují jenom dva bloky skriptu, druhý blok se namapuje na process
blok. Pokud existují tři nebo více bloků skriptu, první blok skriptu se vždy mapuje na begin
blok, poslední blok se mapuje na end
blok a prostřední bloky se mapují na process
blok.
Typ: | ScriptBlock[] |
Position: | 0 |
Default value: | None |
Vyžadováno: | True |
Přijmout vstup kanálu: | False |
Přijmout zástupné znaky: | False |
-RemainingScripts
Určuje všechny bloky skriptu, které nejsou převzaty parametrem Process .
Tento parametr byl představen ve Windows PowerShellu 3.0.
Typ: | ScriptBlock[] |
Position: | Named |
Default value: | None |
Vyžadováno: | False |
Přijmout vstup kanálu: | False |
Přijmout zástupné znaky: | False |
-WhatIf
Zobrazuje, co by se stalo při spuštění rutiny. Rutina se nespustí.
Typ: | SwitchParameter |
Aliasy: | wi |
Position: | Named |
Default value: | False |
Vyžadováno: | False |
Přijmout vstup kanálu: | False |
Přijmout zástupné znaky: | False |
Vstupy
Do této rutiny můžete převést libovolný objekt.
Výstupy
Tato rutina vrátí objekty, které jsou určeny vstupem.
Poznámky
Windows PowerShell obsahuje následující aliasy pro ForEach-Object
:
%
foreach
Rutina ForEach-Object
funguje podobně jako příkaz Foreach , s tím rozdílem , že vstup do příkazu Foreach nelze převést. Další informace o příkazu Foreach najdete v tématu about_Foreach.
Počínaje PowerShellem 4.0 Where
a ForEach
metody byly přidány pro použití s kolekcemi. Další informace o těchto nových metodách najdete about_arrays