about_Automatic_Variables

Kurze Beschreibung

Beschreibt Variablen, die Zustandsinformationen für powerShell erstellen und verwaltet werden.

Konzeptionell gelten die meisten dieser Variablen als schreibgeschützt. Auch wenn sie geschrieben werden können , sollten sie aus Gründen der Abwärtskompatibilität nicht geschrieben werden.

Hier ist eine Liste der automatischen Variablen in PowerShell:

• $$
• $?
• $^
• $_
• $args
• $ConsoleFileName
• $Error
• $Event
• $EventArgs
• $EventSubscriber
• $ExecutionContext
• $false
• $foreach
• $HOME
• $Host
• $input
• $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

Lange Beschreibung

$$

Enthält das letzte Token in der letzten Zeile, die von der Sitzung empfangen wurde.

$?

Enthält den Ausführungsstatus des letzten Befehls. Er enthält True , wenn der letzte Befehl erfolgreich war und False , wenn er fehlgeschlagen ist. Analysefehler führen nicht zur Ausführung, sodass sie sich nicht auf den Wert auswirken $?.

Für Cmdlets und erweiterte Funktionen, die in mehreren Phasen einer Pipeline ausgeführt werden, z. B. in beiden process und end Blöcken, wird der Aufruf this.WriteError() bzw$PSCmdlet.WriteError(). der jeweilige Punkt auf "False" festgelegt$?, wie this.ThrowTerminatingError() und $PSCmdlet.ThrowTerminatingError().

Das Write-Error Cmdlet legt immer unmittelbar nach der Ausführung auf "False" fest, wird jedoch für eine Funktion, die sie aufruft, nicht auf "False" festgelegt $? $?:

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

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

Test-WriteError : Bad
At line:7 char:1
+ Test-WriteError
+ ~~~~~~~~~~~~~~~
    + CategoryInfo          : NotSpecified: (:) [Write-Error], WriteErrorException
    + FullyQualifiedErrorId : Microsoft.PowerShell.Commands.WriteErrorException,Test-WriteError

The $? variable is: False
Now the $? variable is: True

Für letzteres $PSCmdlet.WriteError() sollte stattdessen verwendet werden.

Bei systemeigenen Befehlen (ausführbare Dateien) $? wird auf "True" bei $LASTEXITCODE 0 festgelegt und bei $LASTEXITCODE einem anderen Wert auf "False" festgelegt.

$^

Enthält das erste Token in der letzten Zeile, die von der Sitzung empfangen wurde.

$_

Wie in $PSItem. Enthält das current Objekt im Pipelineobjekt. Sie können diese Variable in Befehlen verwenden, die eine Aktion für jedes Objekt in einer Pipeline ausführen.

Weitere Informationen finden Sie unter about_PSItem.

$args

Enthält ein Array von Werten für nicht deklarierte Parameter, die an eine Funktion, ein Skript oder einen Skriptblock übergeben werden. Wenn Sie eine Funktion erstellen, können Sie die Parameter mit dem param Schlüsselwort deklarieren oder eine durch Trennzeichen getrennte Liste von Parametern in Klammern nach dem Funktionsnamen hinzufügen.

In einer Ereignisaktion enthält die $args Variable Objekte, die die Ereignisargumente des Ereignisses darstellen, das verarbeitet wird. Diese Variable wird nur innerhalb des Action Blocks eines Ereignisregistrierungsbefehls aufgefüllt. Der Wert dieser Variablen kann auch in der SourceArgs-Eigenschaft des PSEventArgs zurückgegebenen Objekts Get-Event gefunden werden.

$ConsoleFileName

Enthält den Pfad der Konsolendatei (.psc1), die zuletzt in der Sitzung verwendet wurde. Diese Variable wird aufgefüllt, wenn Sie PowerShell mit dem PARAMETER "PSConsoleFile " starten oder wenn Sie das Cmdlet zum Exportieren von Export-Console Snap-In-Namen in eine Konsolendatei verwenden.

Wenn Sie das Export-Console Cmdlet ohne Parameter verwenden, wird automatisch die Konsolendatei aktualisiert, die zuletzt in der Sitzung verwendet wurde. Sie können diese automatische Variable verwenden, um die zu aktualisierende Datei zu bestimmen.

Error$

Enthält ein Array von Fehlerobjekten, die die neuesten Fehler darstellen. Der letzte Fehler ist das erste Fehlerobjekt im Array $Error[0].

Um zu verhindern, dass dem $Error Array ein Fehler hinzugefügt wird, verwenden Sie den allgemeinen ErrorAction-Parameter mit dem Wert " Ignore". Weitere Informationen findest du unter about_CommonParameters.

$Event

Enthält ein PSEventArgs Objekt, das das ereignis darstellt, das verarbeitet wird. Diese Variable wird nur innerhalb des Action Blocks eines Ereignisregistrierungsbefehls aufgefüllt, z Register-ObjectEvent. B. . Der Wert dieser Variablen ist dasselbe Objekt, das vom Get-Event Cmdlet zurückgegeben wird. Sie können die Eigenschaften der Event Variablen verwenden, z $Event.TimeGenerated. B. in einem Action Skriptblock.

$EventArgs

Enthält ein Objekt, das das erste Ereignisargument darstellt, das von EventArgs des ereignisses abgeleitet wird, das verarbeitet wird. Diese Variable wird nur innerhalb des Action Blocks eines Ereignisregistrierungsbefehls aufgefüllt. Der Wert dieser Variablen kann auch in der SourceEventArgs-Eigenschaft des PSEventArgs zurückgegebenen Objekts Get-Event gefunden werden.

$EventSubscriber

Enthält ein PSEventSubscriber Objekt, das den Ereignisabonnent des ereignisses darstellt, das verarbeitet wird. Diese Variable wird nur innerhalb des Action Blocks eines Ereignisregistrierungsbefehls aufgefüllt. Der Wert dieser Variablen ist dasselbe Objekt, das vom Get-EventSubscriber Cmdlet zurückgegeben wird.

$ExecutionContext

Enthält ein EngineIntrinsics -Objekt, das den Ausführungskontext des PowerShell-Hosts darstellt. Sie können diese Variable verwenden, um die Ausführungsobjekte zu finden, die für Cmdlets verfügbar sind.

$false

Enthält False. Sie können diese Variable verwenden, um False in Befehlen und Skripts darzustellen, anstatt die Zeichenfolge "false"zu verwenden. Die Zeichenfolge kann als True interpretiert werden, wenn sie in eine nicht leere Zeichenfolge oder in eine ganze Zahl ungleich Null konvertiert wird.

$foreach

Enthält den Enumerator (nicht die resultierenden Werte) einer ForEach-Schleife . Die $ForEach Variable ist nur vorhanden, wenn die ForEach Schleife ausgeführt wird. Sie wird nach Abschluss der Schleife gelöscht.

Enumeratoren enthalten Eigenschaften und Methoden, mit deren Hilfe Sie Schleifenwerte abrufen und die current Schleifeniteration ändern können. Weitere Informationen finden Sie unter Verwenden von Enumeratoren.

$HOME

Enthält den vollständigen Pfad des Startverzeichnisses des Benutzers. Diese Variable verwendet den Wert der Windows-Umgebungsvariablen in der "$env:USERPROFILE" Regel C:\Users\<UserName>.

$Host

Enthält ein Objekt, das die current Hostanwendung für PowerShell darstellt. Sie können diese Variable verwenden, um den current Host in Befehlen darzustellen oder die Eigenschaften des Hosts anzuzeigen oder zu ändern, z$Host.version. B. oder $Host.CurrentCulture.$Host.UI.RawUI.BackGroundColor = "Red"

$input

Enthält einen Enumerator, der alle Eingaben aufzählt, die an eine Funktion übergeben werden. Die $input Variable ist nur für Funktionen, Skriptblöcke (die nicht benannte Funktionen sind) und Skriptdateien (die gespeicherte Skriptblöcke sind) verfügbar.

• In einer Funktion ohne Ein begin- processoder end Block zählt die $input Variable die Auflistung aller Eingaben für die Funktion auf.

• begin Im Block enthält die $input Variable keine Daten.

• process Im Block enthält die $input Variable das current Objekt in der Pipeline.

• end Im Block listet die $input Variable die Auflistung aller Eingaben für die Funktion auf.

  Hinweis

  Sie können die $input Variable nicht sowohl innerhalb des process Blocks als auch des end Blocks in derselben Funktion oder in einem Skriptblock verwenden.

Da $input es sich um einen Enumerator handelt, ist $input der Zugriff auf eine seiner Eigenschaften nicht mehr verfügbar. Sie können in einer anderen Variablen speichern $input , um die $input Eigenschaften wiederzuverwenden.

Enumeratoren enthalten Eigenschaften und Methoden, mit deren Hilfe Sie Schleifenwerte abrufen und die current Schleifeniteration ändern können. Weitere Informationen finden Sie unter Verwenden von Enumeratoren.

Die $input Variable ist auch für den durch den -Command Parameter angegebenen Befehl verfügbar, wenn powershell.exe sie über die Befehlszeile aufgerufen wird. Das folgende Beispiel wird über die Windows-Befehlsshell ausgeführt.

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

$LASTEXITCODE

Enthält den Beendigungscode des letzten systemeigenen Programms oder powerShell-Skripts, das ausgeführt wurde.

Für PowerShell-Skripts hängt der Wert davon $LASTEXITCODE ab, wie das Skript aufgerufen wurde und ob das exit Schlüsselwort verwendet wurde:

• Wenn ein Skript das exit Schlüsselwort verwendet:

  $LASTEXITCODE wird auf den Wert festgelegt, der durch das exit Schlüsselwort angegeben wird. Weitere Informationen finden Sie unter about_Language_Keywords.

• Wenn ein Skript direkt aufgerufen wird, z ./Test.ps1. B. mit dem Anrufoperator (&) wie & ./Test.ps1:

  Der Wert von $LASTEXITCODE wird nicht geändert, es sei denn:

  • Das Skript ruft ein anderes Skript auf, das das exit Schlüsselwort verwendet
  • Das Skript ruft einen systemeigenen Befehl auf.
  • Das Skript verwendet das exit Schlüsselwort

• Wenn ein Skript mit powershell.exe dem Parameter "File " aufgerufen wird, $LASTEXITCODE wird folgendes festgelegt:

  • 1 wenn das Skript aufgrund einer Ausnahme beendet wurde
  • Der durch das exit Schlüsselwort angegebene Wert, wenn er im Skript verwendet wird
  • 0 wenn das Skript erfolgreich abgeschlossen wurde

• Wenn ein Skript mit powershell.exe dem Command-Parameter aufgerufen wird, $LASTEXITCODE wird folgendes festgelegt:

  • 1 wenn das Skript aufgrund einer Ausnahme beendet wurde oder das Ergebnis des letzten Befehlssatzes $? auf $false
  • 0wenn das Skript erfolgreich abgeschlossen wurde und das Ergebnis des letzten Befehlssatzes auf $?$true

Weitere Informationen zu den Parametern "Datei" und "Befehl " finden Sie unter about_PowerShell_exe.

$Matches

Die $Matches Variable funktioniert mit den -match Operatoren und -notmatch Operatoren. Wenn Sie skalare Eingaben an den -match Operator senden -notmatch und entweder eine Übereinstimmung erkennt, geben sie einen booleschen Wert zurück und füllen die $Matches automatische Variable mit einer Hashtabelle aller übereinstimmenden Zeichenfolgenwerte auf. Die $Matches Hashtabelle kann auch mit Erfassungen aufgefüllt werden, wenn Sie reguläre Ausdrücke mit dem -match Operator verwenden.

Weitere Informationen zum -match Operator finden Sie unter about_Comparison_Operators. Weitere Informationen zu regulären Ausdrücken finden Sie unter about_Regular_Expressions.

Die $Matches Variable funktioniert auch in einer switch Anweisung mit dem -Regex Parameter. Sie wird auf die gleiche Weise wie die -match Operatoren aufgefüllt -notmatch . Weitere Informationen zur switch Anweisung finden Sie unter about_Switch.

$MyInvocation

Enthält Informationen zum current Befehl, z. B. Name, Parameter, Parameterwerte und Informationen darüber, wie der Befehl gestartet, aufgerufen oder aufgerufen wurde, z. B. den Namen des Skripts, das den current Befehl aufgerufen hat.

$MyInvocation wird nur für Skripts, Funktions- und Skriptblöcke aufgefüllt. Sie können die Informationen im System.Management.Automation.InvocationInfo-Objekt verwenden, das $MyInvocation im current Skript zurückgibt, z. B. den Namen einer Funktion ($MyInvocation.MyCommand.Name), um den current Befehl zu identifizieren. Dies ist nützlich, um den Namen des current Skripts zu finden.

Ab PowerShell 3.0 MyInvocation gibt es die folgenden neuen Eigenschaften.

• PSScriptRoot – Enthält den vollständigen Pfad zu dem Skript, das den current Befehl aufgerufen hat. Der Wert dieser Eigenschaft wird nur aufgefüllt, wenn der Aufrufer ein Skript ist.
• PSCommandPath – Enthält den vollständigen Pfad und Dateinamen des Skripts, das den current Befehl aufgerufen hat. Der Wert dieser Eigenschaft wird nur aufgefüllt, wenn der Aufrufer ein Skript ist.

Im Gegensatz zu den $PSScriptRoot und $PSCommandPath automatischen Variablen enthalten die PSScriptRoot - und PSCommandPath-Eigenschaften der $MyInvocation automatischen Variablen Informationen über den Aufrufer oder das aufrufende Skript, nicht das current Skript.

$NestedPromptLevel

Enthält die current Eingabeaufforderungsebene. Der Wert 0 gibt die ursprüngliche Eingabeaufforderungsebene an. Der Wert wird erhöht, wenn Sie eine geschachtelte Ebene eingeben und beim Beenden erhöht werden.

PowerShell stellt beispielsweise eine geschachtelte Eingabeaufforderung dar, wenn Sie die $Host.EnterNestedPrompt Methode verwenden. PowerShell stellt auch eine geschachtelte Eingabeaufforderung vor, wenn Sie einen Haltepunkt im PowerShell-Debugger erreichen.

Wenn Sie eine geschachtelte Eingabeaufforderung eingeben, hält PowerShell den current Befehl an, speichert den Ausführungskontext und erhöht den Wert der $NestedPromptLevel Variablen. Um zusätzliche geschachtelte Eingabeaufforderungen (bis zu 128 Ebenen) zu erstellen oder zur ursprünglichen Eingabeaufforderung zurückzukehren, schließen Sie den Befehl ab oder geben Sie ein exit.

Die $NestedPromptLevel Variable hilft Ihnen, die Eingabeaufforderungsstufe nachzuverfolgen. Sie können eine alternative PowerShell-Eingabeaufforderung erstellen, die diesen Wert enthält, damit er immer sichtbar ist.

$null

$null ist eine automatische Variable, die einen Null - oder leeren Wert enthält. Sie können diese Variable verwenden, um einen fehlenden oder nicht definierten Wert in Befehlen und Skripts darzustellen.

PowerShell behandelt $null ein Objekt mit einem Wert oder einem Platzhalter, sodass Sie einen leeren Wert in einer Auflistung von Werten darstellen können $null .

Wenn sie beispielsweise $null in einer Auflistung enthalten ist, wird sie als eines der Objekte gezählt.

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

3

Wenn Sie die $null Variable an das ForEach-Object Cmdlet weiterleiten, generiert sie einen Wert für $null, genau wie für die anderen Objekte.

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

Hello one
Hello
Hello three

Daher können Sie keinen Parameterwert bedeuten $null . Ein Parameterwert von $null Außerkraftsetzungen des Standardparameterwerts.

Da PowerShell die $null Variable jedoch als Platzhalter behandelt, können Sie sie in Skripts wie der folgenden verwenden, was nicht funktioniert, wenn $null sie ignoriert würden.

$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

Enthält den Prozessbezeichner (Process Identifier, PID) des Prozesses, der die current PowerShell-Sitzung hosten soll.

$PROFILE

Enthält den vollständigen Pfad des PowerShell-Profils für den current Benutzer und die current Hostanwendung. Sie können diese Variable verwenden, um das Profil in Befehlen darzustellen. Sie können es beispielsweise in einem Befehl verwenden, um zu bestimmen, ob ein Profil erstellt wurde:

Test-Path $PROFILE

Sie können es auch in einem Befehl verwenden, um ein Profil zu erstellen:

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

Sie können es in einem Befehl verwenden, um das Profil in notepad.exe zu öffnen:

notepad.exe $PROFILE

$PSBoundParameters

Enthält ein Wörterbuch der Parameter, die an ein Skript oder eine Funktion und deren current Werte übergeben werden. Diese Variable weist einen Wert nur in einem Bereich auf, in dem Parameter deklariert werden, z. B. ein Skript oder eine Funktion. Sie können sie verwenden, um die current Werte von Parametern anzuzeigen oder zu ändern oder Parameterwerte an ein anderes Skript oder eine andere Funktion zu übergeben.

In diesem Beispiel übergibt die Test2-Funktion die $PSBoundParameters Funktion Test1 . Dies $PSBoundParameters wird im Format von Schlüssel und Wert angezeigt.

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

Enthält ein Objekt, das das Cmdlet oder die erweiterte Funktion darstellt, die ausgeführt wird.

Sie können die Eigenschaften und Methoden des Objekts in Ihrem Cmdlet oder Funktionscode verwenden, um auf die Verwendungsbedingungen zu reagieren. Die ParameterSetName-Eigenschaft enthält beispielsweise den Namen des verwendeten Parametersatzes, und die ShouldProcess-Methode fügt dem Cmdlet dynamisch die Parameter WhatIf und Confirm hinzu.

Weitere Informationen zur $PSCmdlet automatischen Variablen finden Sie unter about_Functions_CmdletBindingAttribute und about_Functions_Advanced.

$PSCommandPath

Enthält den vollständigen Pfad und Dateinamen des skripts, das ausgeführt wird. Diese Variable ist in allen Skripts gültig.

$PSCulture

Enthält den Namen der Kultur, die derzeit im Betriebssystem verwendet wird. Die Kultur bestimmt das Anzeigeformat von Elementen wie Zahlen, Währungen und Datumsangaben und wird in einem System.Globalization.CultureInfo -Objekt gespeichert. Wird Get-Culture verwendet, um die Kultur des Computers anzuzeigen. $PSCulture enthält den Wert der Name-Eigenschaft .

$PSDebugContext

Beim Debuggen enthält diese Variable Informationen zur Debugumgebung. Andernfalls enthält sie einen NULL-Wert . Daher können Sie es verwenden, um zu bestimmen, ob der Debugger über Kontrolle verfügt. Beim Auffüllen enthält es ein PsDebugContext-Objekt mit Breakpoints- und InvocationInfo-Eigenschaften. Die InvocationInfo-Eigenschaft verfügt über mehrere nützliche Eigenschaften, einschließlich der Location-Eigenschaft . Die Location-Eigenschaft gibt den Pfad des Skripts an, das gedebuggt wird.

$PSEdition

Enthält denselben Wert in $PSVersionTable.PSEdition. Diese Variable ist für die Verwendung in Modulmanifestdateien verfügbar, während $PSVersionTable dies nicht der Fall ist.

$PSHOME

Enthält den vollständigen Pfad des Installationsverzeichnisses für PowerShell, in der Regel $env:windir\System32\PowerShell\v1.0 in Windows-Systemen. Sie können diese Variable in den Pfaden von PowerShell-Dateien verwenden. Mit dem folgenden Befehl werden beispielsweise die konzeptionellen Hilfethemen für das Wort "Hilfe" durchsucht:

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

$PSItem

Wie in $_. Enthält das current Objekt im Pipelineobjekt. Sie können diese Variable in Befehlen verwenden, die eine Aktion für jedes Objekt in einer Pipeline ausführen.

Weitere Informationen finden Sie unter about_PSItem.

$PSScriptRoot

Enthält den vollständigen Pfad des übergeordneten Verzeichnisses des ausführenden Skripts.

In PowerShell 2.0 ist diese Variable nur in Skriptmodulen (.psm1) gültig. Ab PowerShell 3.0 ist sie in allen Skripts gültig.

$PSSenderInfo

Enthält Informationen zu dem Benutzer, der die PSSession gestartet hat, einschließlich der Benutzeridentität und der Zeitzone des ursprünglichen Computers. Diese Variable ist nur in PSSessions verfügbar.

Die $PSSenderInfo Variable enthält eine benutzerdefinierte Eigenschaft, ApplicationArguments, die standardmäßig nur die $PSVersionTable aus der ursprünglichen Sitzung enthält. Verwenden Sie den ApplicationArguments-Parameter des New-PSSessionOption Cmdlets, um der ApplicationArguments-Eigenschaft Daten hinzuzufügen.

$PSUICulture

Enthält den Namen der Benutzeroberflächenkultur, die im Betriebssystem konfiguriert ist. Die Benutzeroberflächenkultur bestimmt, welche Textzeichenfolgen für die Benutzeroberflächenelemente, z. B. Menüs und Meldungen, verwendet werden. Dies ist der Wert der System.Globalization.CultureInfo.CurrentUICulture.Name Eigenschaft des Systems. Verwenden Sie Get-UICulture das Cmdlet, um das System.Globalization.CultureInfo-Objekt für das System abzurufen.

$PSVersionTable

Enthält eine schreibgeschützte Hashtabelle, in der Details zur Version von PowerShell angezeigt werden, die in der current Sitzung ausgeführt wird. Die Tabelle enthält die folgenden Elemente:

• BuildVersion – Die Buildnummer der current Version
• CLRVersion – Die Version der Common Language Runtime (CLR)
• PSCompatibleVersions – Versionen von PowerShell, die mit der current Version kompatibel sind
• PSEdition - Diese Eigenschaft hat den Wert "Desktop", für Windows Server- und Windows-Clientversionen. Diese Eigenschaft weist den Wert "Core" für PowerShell auf, der unter Nano Server oder Windows IoT ausgeführt wird.
• PSRemotingProtocolVersion – Die Version des PowerShell-Remoteverwaltungsprotokolls.
• PSVersion – Die PowerShell-Versionsnummer
• SerializationVersion – Die Version der Serialisierungsmethode
• WSManStackVersion – Die Versionsnummer des WS-Management-Stapels

$PWD

Enthält ein Pfadobjekt, das den vollständigen Pfad des current Verzeichnisspeicherorts für den current PowerShell-Runspace darstellt.

$Sender

Enthält das Objekt, das dieses Ereignis generiert hat. Diese Variable wird nur innerhalb des Aktionsblocks eines Ereignisregistrierungsbefehls aufgefüllt. Der Wert dieser Variablen kann auch in der Sender-Eigenschaft des PSEventArgs zurückgegebenen Objekts Get-Event gefunden werden.

$ShellId

Enthält den Bezeichner der current Shell.

$StackTrace

Enthält eine Stapelablaufverfolgung für den letzten Fehler.

$switch

Enthält den Enumerator nicht die resultierenden Werte einer Switch Anweisung. Die $switch Variable ist nur vorhanden, wenn die Switch Anweisung ausgeführt wird. Sie wird gelöscht, wenn die Anweisung die switch Ausführung abgeschlossen hat. Weitere Informationen finden Sie unter about_Switch.

Enumeratoren enthalten Eigenschaften und Methoden, mit deren Hilfe Sie Schleifenwerte abrufen und die current Schleifeniteration ändern können. Weitere Informationen finden Sie unter Verwenden von Enumeratoren.

$this

Die $this Variable wird in Skriptblöcken verwendet, die Klassen erweitern, um auf die Instanz der Klasse selbst zu verweisen.

Mit dem Extensible Type System (ETS) von PowerShell können Sie Klassen mithilfe von Skriptblöcken Eigenschaften hinzufügen. In einem Skriptblock, der eine Skripteigenschaft oder Skriptmethode definiert, bezieht sich die $this Variable auf eine Instanz des Objekts der Klasse, die erweitert wird. PowerShell verwendet z. B. ETS, um der FileInfo-Klasse die BaseName-Eigenschaft hinzuzufügen.

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};}

Weitere Informationen finden Sie unter about_Types.ps1xml.

In einer PowerShell-Klasse bezieht sich die $this Variable auf das Instanzobjekt der Klasse selbst und ermöglicht den Zugriff auf in der Klasse definierte Eigenschaften und Methoden. Weitere Informationen finden Sie unter about_Classes.

Die $this Variable wird auch von .NET-Ereignisklassen verwendet, die Skriptblöcke als Stellvertretungen für den Ereignishandler verwenden. In diesem Szenario stellt das Objekt dar, $this das das Ereignis stammt, das als Ereignissender bezeichnet wird.

$True

Enthält True. Sie können diese Variable verwenden, um True in Befehlen und Skripts darzustellen.

Verwenden von Enumeratoren

Die $input, $foreachund $switch Variablen sind alle Enumeratoren, die zum Durchlaufen der Werte verwendet werden, die von ihrem enthaltenden Codeblock verarbeitet werden.

Ein Enumerator enthält Eigenschaften und Methoden, mit deren Hilfe Sie iterations- oder reset voranschreiten oder Iterationswerte abrufen können. Direktes Bearbeiten von Enumeratoren wird nicht als bewährte Methode betrachtet.

• Innerhalb von Schleifen sollten Schlüsselwörter für flusssteuerungen umgebrochen und fortgesetzt werden.

• Innerhalb von Funktionen, die Pipelineeingaben akzeptieren, empfiehlt es sich, Parameter mit den Attributen ValueFromPipeline oder ValueFromPipelineByPropertyName zu verwenden.

  Weitere Informationen finden Sie unter about_Functions_Advanced_Parameters.

MoveNext

Die MoveNext-Methode wechselt den Enumerator zum nächsten Element der Auflistung. MoveNext gibt zurück True , wenn der Enumerator erfolgreich erweitert wurde, False wenn der Enumerator das Ende der Auflistung übergeben hat.

$input.MoveNext() | Out-Null

[void]$input.MoveNext()

Reset

Die Reset Methode legt den Enumerator auf seine Anfangsposition fest, die sich vor dem ersten Element in der Auflistung befindet.

Current

Die Current Eigenschaft ruft das Element in der Auflistung oder Pipeline an der current Position des Enumerators ab.

Die Current Eigenschaft gibt weiterhin dieselbe Eigenschaft zurück, bis MoveNext aufgerufen wird.

Beispiele

Beispiel 1: Verwenden der $input Variablen

Im folgenden Beispiel löscht der Zugriff auf die Variable die $input Variable bis zum nächsten Ausführen des Prozessblocks. Mit der Reset Methode wird die $input Variable auf den current Pipelinewert zurückgesetzt.

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

Der Prozessblock führt die $input Variable automatisch weiter, auch wenn Sie nicht darauf zugreifen.

$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

Beispiel 2: Verwenden von $input außerhalb des Prozessblocks

Außerhalb des Prozessblocks stellt die $input Variable alle Werte dar, die in die Funktion weitergeleitet werden.

• Beim Zugriff auf die $input Variable werden alle Werte gelöscht.
• Die Reset Methode setzt die gesamte Auflistung zurück.
• Die Current Eigenschaft wird nie aufgefüllt.
• Die MoveNext-Methode gibt "false" zurück, da die Auflistung nicht erweitert werden kann.
  • Durch Aufrufen von MoveNext wird die $input Variable gelöscht.

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:

Beispiel 3: Verwenden des $input.Current Eigentum

Mit der Current Eigenschaft kann mehrmals auf den current Pipelinewert zugegriffen werden, ohne die Reset Methode zu verwenden. Der Prozessblock ruft die MoveNext-Methode nicht automatisch auf.

Die Current Eigenschaft wird niemals aufgefüllt, es sei denn, Sie rufen MoveNext explizit auf. Auf die Current Eigenschaft kann mehrmals innerhalb des Prozessblocks zugegriffen werden, ohne dessen Wert zu löschen.

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

Beispiel 4: Verwenden der $foreach Variablen

$input Im Gegensatz zur Variablen stellt die $foreach Variable immer alle Elemente in der Auflistung dar, wenn direkt auf sie zugegriffen wird. Verwenden Sie die Current Eigenschaft, um auf das Auflistungselement current und die Reset MoveNext-Methoden zuzugreifen, um ihren Wert zu ändern.

Die folgende Schleife wird nur zweimal ausgeführt. In der zweiten Iteration wird die Auflistung in das dritte Element verschoben, bevor die Iteration abgeschlossen ist. Nach der zweiten Iteration sind jetzt keine weiteren Werte zum Durchlaufen vorhanden, und die Schleife wird beendet.

Die MoveNext-Eigenschaft wirkt sich nicht auf die Variable aus, die für die Durchlaufen der Auflistung ($Num) ausgewählt wurde.

$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

Mit der Reset Methode wird das current Element in der Auflistung zurückgesetzt. Im folgenden Beispiel werden die ersten beiden Elemente zweimal durchlaufen, da die Reset Methode aufgerufen wird. Nach den ersten beiden Schleifen schlägt die if Anweisung fehl, und die Schleife durchläuft normalerweise alle drei Elemente.

$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

Beispiel 5: Verwenden der $switch Variablen

Die $switch Variable weist genau die gleichen Regeln wie die $foreach Variable auf. Im folgenden Beispiel werden alle Enumerationskonzepte veranschaulicht.

$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

Siehe auch

• about_Functions
• about_Functions_Advanced
• about_Functions_Advanced_Methods
• about_Functions_Advanced_Parameters
• about_Functions_OutputTypeAttribute
• about_Functions_CmdletBindingAttribute
• about_Hash_Tables
• about_Preference_Variables
• about_Splatting
• about_Variables