about_Foreach

簡単な説明

項目のコレクション内のすべての項目を走査するために使用できる言語コマンドについて説明します。

長い説明

ステートメント foreach (ループとも foreach 呼ばれる) は、項目のコレクション内の一連の値をステップ実行 (反復処理) するための言語コンストラクトです。

走査するコレクションの最も単純で最も一般的な型は配列です。 ループ内 foreach では、配列内の各項目に対して 1 つ以上のコマンドを実行するのが一般的です。

構文

構文を次に示 foreach します。

foreach ($<item> in $<collection>){<statement list>}

かっこで囲まれた foreach ステートメントの部分は、反復処理する変数とコレクションを表します。 PowerShell では、ループの実行時に $<item> 変数が自動的に foreach 作成されます。 ループを反復処理する前に、変数はコレクション内の値に設定されます。 ステートメントの後の ブロック 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 して、文字 a を表示します。 次に ループを通過する場合は $letter 、 が "b"に設定されます。 ループに foreach d という文字が表示された後、PowerShell はループを終了します。

foreach ステートメントは、項目のコレクションを返すコマンドレットと共に使用することもできます。 次の例では、Foreach ステートメントは、 コマンドレットによって返される項目の一覧をステップ実行 Get-ChildItem します。

foreach ($file in Get-ChildItem)
{
  Write-Host $file
}

ステートメントを使用して、返される if 結果を制限することで、この例を絞り込みできます。 次の例ではforeach``if、 ステートメントは前の例と同じループ操作を実行しますが、100 キロバイト (KB) を超えるファイルに結果を制限する ステートメントを追加します。

foreach ($file in Get-ChildItem)
{
  if ($file.length -gt 100KB)
  {
    Write-Host $file
  }
}

この例では、ループは foreach 変数の プロパティを $file 使用して比較演算 () を実行します$file.length -gt 100KB。 変数 $file には、 コマンドレットによって返される オブジェクト内のすべてのプロパティが格納 Get-ChildItem されます。 したがって、単なるファイル名以外の値を返す場合があります。 次の例では、PowerShell はステートメントリスト内の長さと最後のアクセス時刻を返します。

foreach ($file in Get-ChildItem)
{
  if ($file.length -gt 100KB)
  {
    Write-Host $file
    Write-Host $file.length
    Write-Host $file.lastaccesstime
  }
}

この例では、ステートメント リストで 1 つのコマンドを実行する方法に限定されません。

ループの外側で変数を使用し 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 100 KB in the current directory."
}
else {
  Write-Host "No files greater than 100 KB in the current directory."
}

前の例$i``0では、変数は ループの外側に設定され、100 KB を超えるファイルが見つかった各ファイルのループ内で変数がインクリメントされます。 ループが終了すると、 ステートメント if$i の値を評価して、100 KB を超えるすべてのファイルの数を表示します。 または、100 KB を超えるファイルが見つからなかったことを示すメッセージが表示されます。

前の例では、ファイル長の結果を書式設定する方法も示しています。

($file.length / 1024).ToString("F0")

値を 1,024 で割って結果をバイトではなく KB 単位で表示し、結果の値は固定小数点書式指定子を使用して書式設定され、結果から 10 進値を削除します。 0 を指定すると、書式指定子に小数点以下の桁数は表示されます。

次の例では、定義された関数は PowerShell スクリプトとスクリプト モジュールを解析し、 に含まれる関数の場所を返します。 この例では、MoveNextforeach スクリプト ブロック内の 変数の メソッド (skip X``Forループの場合と同様に動作) $foreach 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]) {
        Write-Verbose "From pipeline"
        $_
      } else {
        Write-Verbose "From parameter, $Path"
        Get-Item -Path $Path
      }
      $parser = [System.Management.Automation.Language.Parser]
      Write-Verbose "lets start the foreach loop on `$filesToProcess with $($filesToProcess.count) as count"
      foreach ($item in $filesToProcess) {
        Write-Verbose "$item"
        if ($item.PSIsContainer -or
            $item.Extension -notin @('.ps1', '.psm1')) {
          continue
        }
        $tokens = $errors = $null
        $parser::ParseFile($item.FullName, ([REF]$tokens),
          ([REF]$errors)) | Out-Null
        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
          }
          Add-Member -InputObject $functionPosition `
            -TypeName FunctionPosition -PassThru
        }
      }
    }
    catch {
      throw
    }
  }
}

関連項目