about_Foreach
簡単な説明
項目のコレクション内のすべての項目を走査するために使用できる言語コマンドについて説明します。
詳細な説明
foreach
ステートメントは、コレクション内の値のセットを反復処理するための言語コンストラクトです。
走査するコレクションの最も単純で最も一般的な型は配列です。
foreach
ループ内では、配列内の各項目に対して 1 つ以上のコマンドを実行するのが一般的です。
構文
foreach
構文を次に示します。
foreach ($<item> in $<collection>){<statement list>}
かっこ内の foreach
ステートメントの部分は、反復処理する変数とコレクションを表します。 PowerShell は、foreach
ループの実行時に変数$<item>
を自動的に作成します。 各イテレーションの開始時に、 foreach
項目変数をコレクション内の次の値に設定します。 {<statement list>}
ブロックには、イテレーションごとに実行するコマンドが含まれています。
例
たとえば、次の例の foreach
ループは、 $letterArray
配列の値を表示します。
$letterArray = 'a','b','c','d'
foreach ($letter in $letterArray)
{
Write-Host $letter
}
この例では、 $letterArray
には、 a
、 b
、 c
、および d
の文字列値が含まれています。 foreach
ステートメントを初めて実行すると、$letter
変数が $letterArray
の最初の項目 (a
) と等しくなります。 次に、 Write-Host
を使用して値を表示します。 次にループを通過すると、 $letter
は b
に設定されます。 パターンは、配列内の各項目に対して繰り返されます。
項目のコレクションを返すコマンドレットで foreach
ステートメントを使用することもできます。 次の例では、 foreach
ステートメントは、 Get-ChildItem
コマンドレットによって返される項目の一覧をステップ実行します。
foreach ($file in Get-ChildItem)
{
Write-Host $file
}
if
ステートメントを使用して例を絞り込んで、返される結果を制限できます。 次の例では、 if
ステートメントによって結果が 100 KB (KB) を超えるファイルに制限されています。
foreach ($file in Get-ChildItem)
{
if ($file.Length -gt 100KB)
{
Write-Host $file
}
}
この例では、 foreach
ループは、 $file
変数のプロパティを使用して比較操作 ($file.length -gt 100KB
) を実行します。 $file
変数には、Get-ChildItem
によって返されるオブジェクトのすべてのプロパティがあります。
次の例では、ステートメント リスト内の長さと最後のアクセス時刻がスクリプトに表示されます。
foreach ($file in Get-ChildItem)
{
if ($file.Length -gt 100KB)
{
Write-Host $file
Write-Host $file.Length
Write-Host $file.LastAccessTime
}
}
foreach
ループの外部から変数を使用することもできます。 次の例では、サイズが 100 KB を超えるファイルをカウントします。
$i = 0
foreach ($file in Get-ChildItem) {
if ($file.length -gt 100KB) {
Write-Host $file 'file size:' ($file.length / 1024).ToString('F0') KB
$i = $i + 1
}
}
if ($i -ne 0) {
Write-Host
Write-Host $i ' file(s) over 100KB in the current directory.'
}
else {
Write-Host 'No files greater than 100KB in the current directory.'
}
前の例では、 $i
はループの外側にある 0
の値で始まります。
次に、 $i
は、100 KB を超える各ファイルのループ内でインクリメントされます。 ループが終了すると、 if
ステートメントは $i
の値を評価して、100 KB を超えるファイルの数を表示します。
前の例では、ファイルの長さの結果を書式設定する方法も示しています。
($file.length / 1024).ToString('F0')
値は 1,024 で除算され、結果はバイトではなくキロバイト単位で表示され、結果の値は固定小数点書式指定子を使用して書式設定され、結果から 10 進値が削除されます。 0
では、書式指定子に小数点以下の桁数が表示されません。
次の関数は、PowerShell スクリプトとスクリプト モジュールを解析し、その中に含まれる関数の場所を返します。 この例では、foreach
スクリプト ブロック内で$foreach
変数のMoveNext
メソッドとCurrent
プロパティを使用する方法を示します。
詳細については、「 列挙子の使用」を参照してください。
function Get-FunctionPosition {
[CmdletBinding()]
[OutputType('FunctionPosition')]
param(
[Parameter(Position = 0, Mandatory,
ValueFromPipeline, ValueFromPipelineByPropertyName)]
[ValidateNotNullOrEmpty()]
[Alias('PSPath')]
[System.String[]]
$Path
)
process {
try {
$filesToProcess = if ($_ -is [System.IO.FileSystemInfo]) {
$_
} else {
Get-Item -Path $Path
}
$parser = [System.Management.Automation.Language.Parser]
foreach ($item in $filesToProcess) {
if ($item.PSIsContainer -or
$item.Extension -notin @('.ps1', '.psm1')) {
continue
}
$tokens = $errors = $null
$ast = $parser::ParseFile($item.FullName, ([ref]$tokens),
([ref]$errors))
if ($errors) {
$msg = "File '{0}' has {1} parser errors." -f $item.FullName,
$errors.Count
Write-Warning $msg
}
:tokenLoop foreach ($token in $tokens) {
if ($token.Kind -ne 'Function') {
continue
}
$position = $token.Extent.StartLineNumber
do {
if (-not $foreach.MoveNext()) {
break tokenLoop
}
$token = $foreach.Current
} until ($token.Kind -in @('Generic', 'Identifier'))
$functionPosition = [pscustomobject]@{
Name = $token.Text
LineNumber = $position
Path = $item.FullName
}
$addMemberSplat = @{
InputObject = $functionPosition
TypeName = 'FunctionPosition'
PassThru = $true
}
Add-Member @addMemberSplat
}
}
}
catch {
throw
}
}
}
関連項目
PowerShell