about_Automatic_Variables

[アーティクル]
05/09/2024

簡単な説明

PowerShell によって作成および管理されるの状態情報を格納する変数について説明します。

概念的には、これらの変数のほとんどは読み取り専用と見なされます。書き込 み可能 であっても、下位互換性のために書き込 むべきではありません 。

PowerShell の自動変数の一覧を次に示します。

$$
$?
$^
$_
$args
$ConsoleFileName
$EnabledExperimentalFeatures
$error
$Event
$EventArgs
$EventSubscriber
$ExecutionContext
$false
$foreach
ホーム
$Host
$input
$IsCoreCLR
$IsLinux
$IsMacOS
$IsWindows
$LASTEXITCODE
$Matches
$MyInvocation
$NestedPromptLevel
$null
$PID
$profile
$PSBoundParameters
$PSCmdlet
$PSCommandPath
$PSCulture
$PSDebugContext
$PSEdition
$PSHOME
$PSItem
$PSScriptRoot
$PSSenderInfo
$PSUICulture
$PSVersionTable
$PWD
$Sender
$ShellId
$StackTrace
$switch
$this
$true

長い説明

$$

セッションによって受信された最後の行の最後のトークンが含まれます。

$?

最後のコマンドの実行状態を格納します。最後のコマンドが成功した場合は True 、失敗した場合 は False が含まれます。

パイプライン内の複数のステージで実行されるコマンドレットと高度な関数の場合 (たとえば、ブロックと end ブロックの両方processで、 this.WriteError() とのように、this.ThrowTerminatingError()$PSCmdlet.ThrowTerminatingError()任意のポイントセットでまたは $PSCmdlet.WriteError() をそれぞれ False に設定$?します)。

コマンドレットはWrite-Error、実行直後に常に False に設定$?されますが、呼び出し元の関数では False には設定$?されません。

function Test-WriteError
{
    Write-Error "Bad"
    "The `$? variable is: $?"
}

Test-WriteError
"Now the `$? variable is: $?"

Test-WriteError:
Line |
   7 |  Test-WriteError
     |  ~~~~~~~~~~~~~~~
     | Bad
The $? variable is: False
Now the $? variable is: True

後者の目的では、代わりにを $PSCmdlet.WriteError() 使用する必要があります。

ネイティブコマンド (実行可能ファイル) $? では、が 0 の場合$LASTEXITCODEは True に設定され、が他の値の場合$LASTEXITCODEは False に設定されます。

注意

PowerShell 7 まで、かっこ(...)内のステートメント、部分式構文$(...)、または配列式@(...)をラップすると、常に True にリセット$?されます。たとえば、 (Write-Error) は True と表示されます$?。この動作は PowerShell 7 で変更され、これらの式で最後に実行されたコマンドの実際の成功が常に反映されます $? 。

$^

セッションによって受信された最後の行の最初のトークンが含まれます。

$_

$PSItem と同じ。パイプラインオブジェクト内の現在のオブジェクトを格納します。この変数は、パイプライン内のすべてのオブジェクトに対してアクションを実行するコマンドで使用できます。

詳細については、「 about_PSItem」を参照してください。

$args

関数、スクリプト、またはスクリプトブロックに渡される宣言されていないパラメーターの値の配列を格納します。関数を作成するときに、キーワード (keyword)を使用してパラメーターをparam宣言するか、関数名の後にかっこで囲まれたパラメーターのコンマ区切りのリストを追加します。

イベントアクションでは、 $args 変数には、処理中のイベントのイベント引数を表すオブジェクトが含まれます。この変数は、イベント登録コマンドの Action ブロック内でのみ設定されます。この変数の値は、を返す PSEventArgs オブジェクトの SourceArgs プロパティにも含Get-Eventまれています。

$ConsoleFileName

セッションで最後に使用されたコンソールファイル (.psc1) のパスを格納します。この変数は、 PSConsoleFile パラメーターを使用して PowerShell を起動するとき、またはコマンドレットを Export-Console 使用してスナップイン名をコンソールファイルにエクスポートするときに設定されます。

パラメーターを指定せずにコマンドレットを Export-Console 使用すると、セッションで最後に使用されたコンソールファイルが自動的に更新されます。この自動変数を使用して、更新するファイルを決定できます。

$EnabledExperimentalFeatures

有効になっている試験的な機能の名前の一覧が含まれます。

$Error

最新のエラーを表すエラーオブジェクトの配列を格納します。最新のエラーは、配列 $Error[0]内の最初のエラーオブジェクトです。

配列にエラーが追加 $Error されないようにするには、 ErrorAction 共通パラメーターを使用し、値が Ignore です。詳細については、「about_CommonParameters」を参照してください。

$Event

処理されているイベントを表す PSEventArgs オブジェクトを格納します。この変数は、などのRegister-ObjectEventイベント登録コマンドのブロック内Actionでのみ設定されます。この変数の値は、コマンドレットが返すのと Get-Event 同じオブジェクトです。スクリプトブロックでは、などの$Event.TimeGenerated変数のEventプロパティをAction使用できます。

$EventArgs

処理されているイベントの EventArgs から派生する最初のイベント引数を表すオブジェクトを格納します。この変数は、イベント登録コマンドの Action ブロック内でのみ設定されます。この変数の値は、を返す PSEventArgs オブジェクトGet-Eventの SourceEventArgs プロパティでも確認できます。

$EventSubscriber

処理中のイベントのイベントサブスクライバーを表す PSEventSubscriber オブジェクトを格納します。この変数は、イベント登録コマンドの Action ブロック内でのみ設定されます。この変数の値は、コマンドレットが返すのと Get-EventSubscriber 同じオブジェクトです。

$ExecutionContext

PowerShell ホストの実行コンテキストを表す EngineIntrinsics オブジェクトを格納します。この変数を使用すると、コマンドレットで使用できる実行オブジェクトを検索できます。

$false

False を含みます。この変数を使用すると、文字列 "false"を使用する代わりに、コマンドとスクリプトで False を表すことができます。空でない文字列または 0 以外の整数に変換される場合、文字列は True として解釈できます。

$foreach

ForEach ループの列挙子 (結果の値ではなく) を格納します。変数は $ForEach 、ループの ForEach 実行中にのみ存在し、ループの完了後に削除されます。

列挙子には、ループ値を取得し、現在のループイテレーションを変更するために使用できるプロパティとメソッドが含まれています。詳細については、「列挙子の使用」を参照してください。

ホーム

ユーザーのホームディレクトリの完全なパスを格納します。 Windows では、この変数は Windows 環境変数の値 ( "$env:USERPROFILE" 通常 C:\Users\<UserName>は ) を使用します。 Unix では、この変数は環境変数の値を HOME 使用します。

重要

Windows では、ユーザーのプロファイルの場所をリダイレクトできます。これは、 $HOME と同じ値 "$env:HOMEDRIVE$env:HOMEPATH"を持たない可能性があることを意味します。

$Host

PowerShell の現在のホストアプリケーションを表すオブジェクトを格納します。この変数を使用すると、コマンドで現在のホストを表したり、やなどの$Host.version$Host.CurrentCultureホストのプロパティを表示または変更したりできます$Host.UI.RawUI.BackGroundColor = "Red"。

注意

の色設定 $Host.PrivateData は、ユーザー設定変数に $PSStyle 置き換えられました。詳細については、「 about_ANSI_Terminals」を参照してください。

$input

関数に渡されるすべての入力を列挙する列挙子を含みます。変数は $input 、関数、スクリプトブロック (名前のない関数)、スクリプトファイル (保存されたスクリプトブロック) でのみ使用できます。

、process、または end ブロックのないbegin関数では、変数は$input関数へのすべての入力のコレクションを列挙します。
ブロックでは begin 、変数に $input データが含まれています。
ブロックでは process 、変数には $input パイプライン内の現在のオブジェクトが含まれます。
ブロックでは end 、変数は $input 関数へのすべての入力のコレクションを列挙します。

注意

同じ関数またはスクリプトブロック内の process ブロックとブロックのend両方内で変数を使用$inputすることはできません。

は列挙子であるため $input 、そのプロパティのいずれかにアクセスすると $input 、使用できなくなります。プロパティを再利用するには、別の変数に$inputを格納$inputできます。

変数は $input 、コマンドラインから呼び出されたときにの -Commandpwsh パラメーターで指定されたコマンドでも使用できます。次の例は、Windows コマンドシェルから実行されます。

echo Hello | pwsh -Command """$input World!"""

$IsCoreCLR

現在の $True セッションが .NET Core ランタイム (CoreCLR) で実行されているかどうかを格納します。それ以外の場合はが $False含まれます。

$IsLinux

現在の $True セッションが Linux オペレーティングシステムで実行されているかどうかを格納します。それ以外の場合はが $False含まれます。

$IsMacOS

現在の $True セッションが MacOS オペレーティングシステムで実行されているかどうかを格納します。それ以外の場合はが $False含まれます。

$IsWindows

現在の $TRUE セッションが Windows オペレーティングシステムで実行されているかどうかを格納します。それ以外の場合はが $FALSE含まれます。

$LASTEXITCODE

最後に実行されたネイティブプログラムまたは PowerShell スクリプトの終了コードが含まれます。

PowerShell スクリプトの場合、の$LASTEXITCODE値は、スクリプトの呼び出し方法と、キーワード (keyword)がexit使用されたかどうかによって異なります。

スクリプトでキーワード (keyword)を使用するexit場合:

$LASTEXITCODEは、キーワード (keyword)で指定された値にexit設定されます。詳細については、「 about_Language_Keywords」を参照してください。
スクリプトがのような直接呼び出された場合、 ./Test.ps1またはのような呼び出し演算子 (&) & ./Test.ps1を使用して呼び出される場合。

の $LASTEXITCODE 値は、次の場合を除き変更されません。
- スクリプトは、キーワード (keyword)を使用する別のスクリプトをexit呼び出します
- スクリプトはネイティブコマンドを呼び出します
- スクリプトでは、キーワード (keyword)を使用しますexit
File パラメーターを使用してスクリプトが呼び出pwshされると、 $LASTEXITCODE は次のように設定されます。
- 1 例外が原因でスクリプトが終了した場合
- スクリプトで使用する場合はexit、キーワード (keyword)で指定された値
- 0 スクリプトが正常に完了した場合
Command パラメーターを使用してスクリプトが呼び出pwshされると、 $LASTEXITCODE は次のように設定されます。
- 1 例外が原因でスクリプトが終了した場合、または最後のコマンドの結果がに設定 $? されている場合 $false
- 0 スクリプトが正常に完了し、最後のコマンドの結果がに設定 $? された場合 $true

File パラメーターと Command パラメーターの詳細については、「about_Pwsh」を参照してください。

$Matches

変数は$Matches、演算子と -notmatch 演算子で-match動作します。または -notmatch 演算子にスカラー入力を-match送信し、いずれかの演算子が一致を検出すると、ブール値が返され、一致した文字列値のハッシュテーブルが自動変数に設定$Matchesされます。 $Matches演算子で正規表現を使用する場合は、ハッシュテーブルにキャプチャを設定-matchすることもできます。

演算子の -match 詳細については、「 about_Comparison_Operators」を参照してください。正規表現の詳細については、「 about_Regular_Expressions」を参照してください。

変数は $Matches 、パラメーターを持 switch つ -Regex ステートメントでも機能します。と演算子と-notmatch同じ方法で-match設定されます。ステートメントの switch 詳細については、「 about_Switch」を参照してください。

注意

$Matchesがセッションに設定されると、一致した値が別の一致によって上書きされるまで保持されます。が再び使用され、一致するものが見つからない場合-matchは、に$nullリセット$Matchesされません。以前に一致した値は、別の $Matches 一致が見つかるまで保持されます。

$MyInvocation

現在のコマンドに関する情報 (名前、パラメーター、パラメーター値など)、およびコマンドの起動、呼び出し、呼び出し方法に関する情報 (現在のコマンドを呼び出したスクリプトの名前など) が含まれます。

$MyInvocation は、スクリプト、関数、およびスクリプトブロックに対してのみ設定されます。現在のスクリプトで返される $MyInvocationSystem.Management.Automation.InvocationInfo オブジェクトの情報 (関数 ($MyInvocation.MyCommand.Name) の名前など) を使用して、現在のコマンドを識別できます。これは、現在のスクリプトの名前を見つけるのに役立ちます。

PowerShell 3.0 以降では、 MyInvocation 次の新しいプロパティがあります。

PSScriptRoot - 現在のコマンドを呼び出したスクリプトへの完全なパスが含まれます。このプロパティの値は、呼び出し元がスクリプトである場合にのみ設定されます。
PSCommandPath - 現在のコマンドを呼び出したスクリプトの完全なパスとファイル名が含まれます。このプロパティの値は、呼び出し元がスクリプトである場合にのみ設定されます。

$PSScriptRoot自動変数と $PSCommandPath 自動変数とは異なり、自動変数の PSScriptRoot プロパティと PSCommandPath プロパティには、現在の$MyInvocationスクリプトではなく、呼び出し元または呼び出し元のスクリプトに関する情報が含まれます。

$NestedPromptLevel

現在のプロンプトレベルを格納します。値 0 は、元のプロンプトレベルを示します。入れ子になったレベルを入力すると値がインクリメントされ、終了するとデクリメントされます。

たとえば、メソッドを使用すると、PowerShell によって入れ子になったコマンドプロンプトが $Host.EnterNestedPrompt 表示されます。 PowerShell デバッガーでブレークポイントに到達すると、PowerShell には入れ子になったコマンドプロンプトも表示されます。

入れ子になったプロンプトを入力すると、PowerShell は現在のコマンドを一時停止し、実行コンテキストを保存し、変数の値を $NestedPromptLevel インクリメントします。追加の入れ子になったコマンドプロンプト (最大 128 レベル) を作成するか、元のコマンドプロンプトに戻すには、コマンドを完了するか、「」と入力します exit。

変数は $NestedPromptLevel 、プロンプトレベルを追跡するのに役立ちます。常に表示されるように、この値を含む別の PowerShell コマンドプロンプトを作成できます。

$null

$null は、 null または空の値を含む自動変数です。この変数を使用して、コマンドとスクリプトに存在しない値または未定義の値を表すことができます。

PowerShell は $null 、値またはプレースホルダーを持つオブジェクトとして扱うので、を使用 $null して、値のコレクション内の空の値を表すことができます。

たとえば、がコレクションに含まれている場合 $null 、オブジェクトの 1 つとしてカウントされます。

$a = "one", $null, "three"
$a.count

コマンドレットにForEach-Object変数を$nullパイプすると、他のオブジェクトの場合と同様に、の$null値が生成されます。

"one", $null, "three" | ForEach-Object { "Hello " + $_}

Hello one
Hello
Hello three

その結果、パラメーター値がないことを意味するためにを使用$nullすることはできません。のパラメーター値は $null 、既定のパラメーター値をオーバーライドします。

ただし、PowerShell では変数が $null プレースホルダーとして扱われるため、次のようなスクリプトで使用できます。これは、無視された場合 $null は機能しません。

$calendar = @($null, $null, "Meeting", $null, $null, "Team Lunch", $null)
$days = "Sunday","Monday","Tuesday","Wednesday","Thursday",
        "Friday","Saturday"
$currentDay = 0
foreach($day in $calendar)
{
    if($day -ne $null)
    {
        "Appointment on $($days[$currentDay]): $day"
    }

    $currentDay++
}

Appointment on Tuesday: Meeting
Appointment on Friday: Team lunch

$PID

現在の PowerShell セッションをホストしているプロセスのプロセス識別子 (PID) が含まれます。

$profile

現在のユーザーと現在のホストアプリケーションの PowerShell プロファイルの完全なパスが含まれます。この変数を使用して、コマンドでプロファイルを表すことができます。たとえば、これをコマンドで使用して、プロファイルが作成されているかどうかを確認できます。

Test-Path $PROFILE

または、コマンドでそれを使用してプロファイルを作成できます。

New-Item -ItemType file -Path $PROFILE -Force

コマンドでこれを使用して、notepad.exeでプロファイルを開くことができます。

notepad.exe $PROFILE

$PSBoundParameters

スクリプトまたは関数に渡されるパラメーターとその現在の値のディクショナリが含まれます。この変数には、スクリプトや関数など、パラメーターが宣言されているスコープ内でのみ値があります。これを使用して、パラメーターの現在の値を表示または変更したり、パラメーター値を別のスクリプトまたは関数に渡したりすることができます。

この例では、Test2 関数は Test1$PSBoundParameters 関数にを渡します。は $PSBoundParameters 、キーと値の形式で表示されます。

function Test1 {
   param($a, $b)

   # Display the parameters in dictionary format.
   $PSBoundParameters
}

function Test2 {
   param($a, $b)

   # Run the Test1 function with $a and $b.
   Test1 @PSBoundParameters
}

Test2 -a Power -b Shell

Key   Value
---   -----
a     Power
b     Shell

$PSCmdlet

実行中のコマンドレットまたは高度な関数を表すオブジェクトを格納します。

コマンドレットまたは関数コードでオブジェクトのプロパティとメソッドを使用して、使用条件に応答できます。たとえば、 ParameterSetName プロパティには使用されているパラメーターセットの名前が含まれており、 ShouldProcess メソッドは WhatIf パラメーターと Confirm パラメーターをコマンドレットに動的に追加します。

自動変数の $PSCmdlet 詳細については、「 about_Functions_CmdletBindingAttribute と about_Functions_Advanced」を参照してください。

$PSCommandPath

実行されているスクリプトの完全なパスとファイル名が含まれます。この変数は、すべてのスクリプトで有効です。

$PSCulture

PowerShell 7 以降では、 $PSCulture 現在の PowerShell 実行空間 (セッション) のカルチャが反映されています。 PowerShell 実行空間でカルチャが変更された場合、 $PSCulture その実行空間の値が更新されます。

カルチャは、数値、通貨、日付などの項目の表示形式を決定し、 System.Globalization.CultureInfo オブジェクトに格納されます。を使用して Get-Culture 、コンピューターのカルチャを表示します。 $PSCulture には、 Name プロパティの値が含まれています。

$PSDebugContext

デバッグ中、この変数にはデバッグ環境に関する情報が含まれます。それ以外の場合は、 null 値が含まれます。その結果、デバッガーに制御があるかどうかを判断するために使用できます。設定されると、ブレークポイントと InvocationInfo プロパティを持つ PsDebugContext オブジェクトが含まれます。 InvocationInfo プロパティには、Location プロパティなど、いくつかの便利なプロパティがあります。 Location プロパティは、デバッグ中のスクリプトのパスを示します。

$PSEdition

に同じ値が $PSVersionTable.PSEdition含まれています。この変数はモジュールマニフェストファイルで使用できます。一方 $PSVersionTable 、は使用できません。

$PSHOME

PowerShell (通常 C:\Program Files\PowerShell\7 は Windows システム) のインストールディレクトリの完全なパスが含まれます。この変数は、PowerShell ファイルのパスで使用できます。たとえば、次のコマンドでは、概念的なヘルプトピックで " ヘルプ" という単語を検索します。

Select-String -Pattern Help -Path $PSHOME\en-US\*.txt

$PSItem

$_ と同じ。パイプラインオブジェクト内の現在のオブジェクトを格納します。この変数は、パイプライン内のすべてのオブジェクトに対してアクションを実行するコマンドで使用できます。

詳細については、「 about_PSItem」を参照してください。

$PSScriptRoot

実行中のスクリプトの親ディレクトリの完全なパスを格納します。

PowerShell 2.0 では、この変数はスクリプトモジュール (.psm1) でのみ有効です。 PowerShell 3.0 以降では、すべてのスクリプトで有効です。

$PSSenderInfo

PSSession を開始したユーザーに関する情報 (ユーザー ID や、発信元コンピューターのタイムゾーンなど) が含まれます。この変数は PSSessions でのみ使用できます。

$PSSenderInfo変数には、ユーザーが構成可能なプロパティ ApplicationArguments が含まれています。既定では、元のセッションからののみが$PSVersionTable含まれます。 ApplicationArguments プロパティにデータを追加するには、コマンドレットの ApplicationArguments パラメーターをNew-PSSessionOption使用します。

$PSUICulture

オペレーティングシステムで構成されているユーザーインターフェイス (UI) カルチャの名前を格納します。 UI カルチャは、どのテキスト文字列がメニューやメッセージなどのユーザーインターフェイス要素に使用されるかを決定します。これは System.Globalization.CultureInfo の値です。Currentシステムの UICulture.Name プロパティ。 システムの System.Globalization.CultureInfo オブジェクトを取得するには、コマンドレットを使用しますGet-UICulture。

$PSVersionTable

現在のセッションで実行されている PowerShell のバージョンに関する詳細を表示する読み取り専用ハッシュテーブルが含まれています。テーブルには、次の項目が含まれています。

PSVersion - PowerShell のバージョン番号
PSEdition このプロパティの値は、PowerShell 4 以下の場合は "Desktop" であり、フル機能の Windows エディションでは PowerShell 5.1 です。このプロパティの値Coreは、PowerShell 6 以降と、Windows Nano Server や Windows IoT などのフットプリントの小さいエディションでは Windows PowerShell 5.1 です。
GitCommitId - GitHub のソースファイルのコミット ID。
OS - PowerShell が実行されているオペレーティングシステムの説明。
プラットフォーム - オペレーティングシステムが実行されているプラットフォーム。 Linux と macOS の値は Unix です。 $IsMacOs と $IsLinux を参照してください。
PSCompatibleVersions - 現在のバージョンと互換性のある PowerShell のバージョン
PSRemotingProtocolVersion - PowerShell リモート管理プロトコルのバージョン。
SerializationVersion - シリアル化メソッドのバージョン
WSManStackVersion - WS-Management スタックのバージョン番号

$PWD

現在の PowerShell 実行空間の現在のディレクトリの場所の完全なパスを表すパスオブジェクトを格納します。

注意

PowerShell では、プロセスごとに複数の実行空間がサポートされます。各実行空間には、独自の 現在のディレクトリがあります。これは、プロセスの現在のディレクトリと同じではありません。 [System.Environment]::CurrentDirectory

$Sender

このイベントを生成したオブジェクトを格納します。この変数は、イベント登録コマンドの Action ブロック内でのみ設定されます。この変数の値は、を返す PSEventArgs オブジェクト Get-Event の Sender プロパティでも確認できます。

$ShellId

現在のシェルの識別子を格納します。

$StackTrace

最新のエラーのスタックトレースが含まれています。

$switch

ステートメントの結果の値ではなく、列挙子を Switch 含みます。変数は $switch 、ステートメントの Switch 実行中にのみ存在し、ステートメントの実行が完了すると switch 削除されます。詳細については、「 about_Switch」を参照してください。

$this

変数は $this 、クラス自体のインスタンスを参照するようにクラスを拡張するスクリプトブロックで使用されます。

PowerShell の拡張型システム (ETS) を使用すると、スクリプトブロックを使用してクラスにプロパティを追加できます。スクリプトプロパティまたはスクリプトメソッドを定義するスクリプトブロックでは、 $this 変数は拡張されているクラスのオブジェクトのインスタンスを参照します。たとえば、PowerShell では ETS を使用して 、BaseName プロパティを FileInfo クラスに追加します。

PS> Get-ChildItem .\README.md | Get-Member BaseName | Format-List

TypeName   : System.IO.FileInfo
Name       : BaseName
MemberType : ScriptProperty
Definition : System.Object BaseName {get=if ($this.Extension.Length -gt 0)
             {$this.Name.Remove($this.Name.Length - $this.Extension.Length
             )}else{$this.Name};}

詳細については、「 about_Types.ps1xml」を参照してください。

PowerShell クラスでは、変数は $this クラス自体のインスタンスオブジェクトを参照し、クラスで定義されているプロパティとメソッドへのアクセスを許可します。詳細については、「about_Remote」を参照してください。

変数は $this 、スクリプトブロックをイベントハンドラーのデリゲートとして受け取る .NET イベントクラスでも使用されます。このシナリオでは、 $this はイベントの発生元のオブジェクト (イベント送信者と呼ばれます) を表します。

$true

True を含みます。この変数を使用して、コマンドとスクリプトで True を 表すことができます。

列挙子の使用

、$input$foreach、および $switch 変数はすべて、含まれているコードブロックによって処理される値を反復処理するために使用される列挙子です。

列挙子には、反復を進めたりリセットしたり、反復値を取得したりするために使用できるプロパティとメソッドが含まれています。列挙子を直接操作することはベストプラクティスとは見なされません。

ループ内では、フロー制御キーワードが中断して続行することをお勧めします。
パイプライン入力を受け入れる関数内では、ValueFromPipeline 属性または ValueFromPipelineByPropertyName 属性でパラメーターを使用することをお勧めします。

詳細については、「 about_Functions_Advanced_Parameters」を参照してください。

MoveNext

MoveNext メソッドは、列挙子をコレクションの次の要素に進めます。列挙子がTrue正常に詳細設定された場合、列挙子がコレクションの末尾を超えた場合、 FalseMoveNext はを返します。

注意

MoveNext によって返されるブール値は、出力ストリームに送信されます。出力を非表示にするには、出力を [void] に型キャストするか、Out-Null にパイプ処理します。

$input.MoveNext() | Out-Null

[void]$input.MoveNext()

Reset

メソッドは Reset 、列挙子を最初の位置 (コレクション内の最初の要素の前 ) に設定します。

Current

プロパティは Current 、列挙子の現在位置にあるコレクションまたはパイプライン内の要素を取得します。

MoveNext が呼び出されるまで、プロパティは Current 引き続き同じプロパティを返します。

例

例 1: $input 変数の使用

次の例では、変数に $input アクセスすると、次にプロセスブロックが実行されるまで変数がクリアされます。メソッドを Reset 使用すると、変数が $input 現在のパイプライン値にリセットされます。

function Test
{
    begin
    {
        $i = 0
    }

    process
    {
        "Iteration: $i"
        $i++
        "`tInput: $input"
        "`tAccess Again: $input"
        $input.Reset()
        "`tAfter Reset: $input"
    }
}

"one","two" | Test

Iteration: 0
    Input: one
    Access Again:
    After Reset: one
Iteration: 1
    Input: two
    Access Again:
    After Reset: two

プロセスブロックは、アクセスしない場合でも変数を $input 自動的に進めます。

$skip = $true
function Skip
{
    begin
    {
        $i = 0
    }

    process
    {
        "Iteration: $i"
        $i++
        if ($skip)
        {
            "`tSkipping"
            $skip = $false
        }
        else
        {
            "`tInput: $input"
        }
    }
}

"one","two" | Skip

Iteration: 0
    Skipping
Iteration: 1
    Input: two

例 2: プロセスブロックの外部で$inputを使用する

プロセスブロックの外部では、変数は $input 関数にパイプされたすべての値を表します。

変数にアクセスすると、 $input すべての値がクリアされます。
メソッドは Reset コレクション全体をリセットします。
プロパティに Current 値が設定されることはありません。
MoveNext メソッドは、コレクションを高度にできないため、false を返します。
- MoveNext を呼び出すと、変数がクリアされます$input。

Function All
{
    "All Values: $input"
    "Access Again: $input"
    $input.Reset()
    "After Reset: $input"
    $input.MoveNext() | Out-Null
    "After MoveNext: $input"
}

"one","two","three" | All

All Values: one two three
Access Again:
After Reset: one two three
After MoveNext:

例 3: $inputの使用。Current プロパティ

プロパティを Current 使用すると、メソッドを使用 Reset せずに、現在のパイプライン値に複数回アクセスできます。プロセスブロックは、 MoveNext メソッドを自動的に呼び出しません。

CurrentMoveNext を明示的に呼び出さない限り、プロパティは設定されません。プロパティには Current 、その値をクリアせずに、プロセスブロック内で複数回アクセスできます。

function Current
{
    begin
    {
        $i = 0
    }

    process
    {
        "Iteration: $i"
        $i++
        "`tBefore MoveNext: $($input.Current)"
        $input.MoveNext() | Out-Null
        "`tAfter MoveNext: $($input.Current)"
        "`tAccess Again: $($input.Current)"
    }
}

"one","two" | Current

Iteration: 0
    Before MoveNext:
    After MoveNext: one
    Access Again: one
Iteration: 1
    Before MoveNext:
    After MoveNext: two
    Access Again: two

例 4: $foreach 変数の使用

$input変数とは異なり、変数は$foreach、直接アクセスすると常にコレクション内のすべての項目を表します。現在の Current コレクション要素にアクセスするにはプロパティを使用し、値を Reset 変更するには MoveNext メソッドと MoveNext メソッドを使用します。

注意

ループの各繰り返しでは foreach 、 MoveNext メソッドが自動的に呼び出されます。

次のループは 2 回だけ実行されます。 2 番目のイテレーションでは、イテレーションが完了する前に、コレクションが 3 番目の要素に移動されます。 2 回目の反復の後、反復処理する値がもうなくなり、ループが終了します。

MoveNext プロパティは、コレクション ($Num) を反復処理するために選択された変数には影響しません。

$i = 0
foreach ($num in ("one","two","three"))
{
    "Iteration: $i"
    $i++
    "`tNum: $num"
    "`tCurrent: $($foreach.Current)"

    if ($foreach.Current -eq "two")
    {
        "Before MoveNext (Current): $($foreach.Current)"
        $foreach.MoveNext() | Out-Null
        "After MoveNext (Current): $($foreach.Current)"
        "Num hasn't changed: $num"
    }
}

Iteration: 0
        Num: one
        Current: one
Iteration: 1
        Num: two
        Current: two
Before MoveNext (Current): two
After MoveNext (Current): three
Num hasn't changed: two

メソッドを使用すると、 Reset コレクション内の現在の要素がリセットされます。次の例では、メソッドが呼び出されるため、最初の 2 つの要素を Reset2 回ループ処理します。最初の 2 つのループの後、ステートメントは if 失敗し、ループは通常 3 つの要素すべてを反復処理します。

重要

これにより、無限ループが発生する可能性があります。

$stopLoop = 0
foreach ($num in ("one","two", "three"))
{
    ("`t" * $stopLoop) + "Current: $($foreach.Current)"

    if ($num -eq "two" -and $stopLoop -lt 2)
    {
        $foreach.Reset()
        ("`t" * $stopLoop) + "Reset Loop: $stopLoop"
        $stopLoop++
    }
}

Current: one
Current: two
Reset Loop: 0
        Current: one
        Current: two
        Reset Loop: 1
                Current: one
                Current: two
                Current: three

例 5: $switch 変数の使用

変数には $switch 、変数とまったく同じ規則があります $foreach 。次の例では、すべての列挙子の概念を示します。

注意

MoveNext メソッドの後にステートメントがない場合でも、NotEvaluated ケースが実行されないことbreakに注意してください。

$values = "Start", "MoveNext", "NotEvaluated", "Reset", "End"
$stopInfinite = $false
switch ($values)
{
    "MoveNext" {
        "`tMoveNext"
        $switch.MoveNext() | Out-Null
        "`tAfter MoveNext: $($switch.Current)"
    }
    # This case is never evaluated.
    "NotEvaluated" {
        "`tAfterMoveNext: $($switch.Current)"
    }

    "Reset" {
        if (!$stopInfinite)
        {
            "`tReset"
            $switch.Reset()
            $stopInfinite = $true
        }
    }

    default {
        "Default (Current): $($switch.Current)"
    }
}

Default (Current): Start
    MoveNext
    After MoveNext: NotEvaluated
    Reset
Default (Current): Start
    MoveNext
    After MoveNext: NotEvaluated
Default (Current): End

Share via