Clear-Variable
Löscht den Wert einer Variablen.
Syntax
Clear-Variable [-Name] <string[]> [-Exclude <string[]>] [-Force] [-Include <string[]>] [-PassThru] [-Scope <string>] [-Confirm] [-WhatIf] [<CommonParameters>]
Beschreibung
Mit dem Cmdlet "Clear-Variable" werden die in einer Variablen gespeicherten Daten, jedoch nicht die Variable gelöscht. Anschließend ist der Wert der Variablen NULL (leer). Wenn für die Variable ein Daten- oder Objekttyp angegeben ist, wird mit Clear-Variable der Typ des in der Variablen gespeicherten Objekts beibehalten.
Parameter
-Exclude <string[]>
Lässt die angegebenen Elemente aus. Der Name-Parameter wird durch den Wert dieses Parameters qualifiziert. Geben Sie ein Namenselement oder -muster wie "s*" ein. Platzhalter sind zulässig.
Erforderlich? |
false |
Position? |
named |
Standardwert |
|
Pipelineeingaben akzeptieren? |
false |
Platzhalterzeichen akzeptieren? |
false |
-Force
Ermöglicht es dem Cmdlet, eine Variable selbst dann zu löschen, wenn sie schreibgeschützt ist. Auch bei Verwendung des Force-Parameters kann das Cmdlet keine Konstanten löschen.
Erforderlich? |
false |
Position? |
named |
Standardwert |
|
Pipelineeingaben akzeptieren? |
false |
Platzhalterzeichen akzeptieren? |
false |
-Include <string[]>
Löscht nur die angegebenen Elemente. Der Name-Parameter wird durch den Wert dieses Parameters qualifiziert. Geben Sie ein Namenselement oder -muster wie "s*" ein. Platzhalter sind zulässig.
Erforderlich? |
false |
Position? |
named |
Standardwert |
|
Pipelineeingaben akzeptieren? |
false |
Platzhalterzeichen akzeptieren? |
false |
-Name <string[]>
Gibt den Namen der Variablen an, die gelöscht werden soll. Platzhalter sind zulässig. Dieser Parameter ist erforderlich, der Parametername ("Name") ist jedoch optional.
Erforderlich? |
true |
Position? |
1 |
Standardwert |
|
Pipelineeingaben akzeptieren? |
true (ByPropertyName) |
Platzhalterzeichen akzeptieren? |
false |
-PassThru
Gibt ein Objekt zurück, das die gelöschte Variable darstellt. Standardmäßig wird von diesem Cmdlet keine Ausgabe generiert.
Erforderlich? |
false |
Position? |
named |
Standardwert |
|
Pipelineeingaben akzeptieren? |
false |
Platzhalterzeichen akzeptieren? |
false |
-Scope <string>
Gibt den Gültigkeitsbereich dieses Alias an. Gültige Werte sind "global", "local", "script", oder eine Zahl in Bezug auf den aktuellen Bereich (0 bis zur Anzahl der Bereiche, wobei 0 der aktuelle Bereich und 1 der übergeordnete Bereich ist). Der Standardwert ist "local". Weitere Informationen finden Sie unter "about_Scopes".
Erforderlich? |
false |
Position? |
named |
Standardwert |
|
Pipelineeingaben akzeptieren? |
false |
Platzhalterzeichen akzeptieren? |
false |
-Confirm
Fordert Sie vor der Ausführung des Befehls zur Bestätigung auf.
Erforderlich? |
false |
Position? |
named |
Standardwert |
|
Pipelineeingaben akzeptieren? |
false |
Platzhalterzeichen akzeptieren? |
false |
-WhatIf
Beschreibt die Auswirkungen einer Ausführung des Befehls, ohne den Befehl tatsächlich auszuführen.
Erforderlich? |
false |
Position? |
named |
Standardwert |
|
Pipelineeingaben akzeptieren? |
false |
Platzhalterzeichen akzeptieren? |
false |
<CommonParameters>
Dieses Cmdlet unterstützt die folgenden allgemeinen Parameter: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer und -OutVariable. Weitere Informationen finden Sie unter about_Commonparameters.
Eingaben und Ausgaben
Der Eingabetyp ist der Typ der Objekte, die über die Pipeline an das Cmdlet übergeben werden können. Der Rückgabetyp ist der Typ der Objekte, die das Cmdlet zurückgibt.
Eingaben |
Keiner Objekte können nicht über die Pipeline an Clear-Variable übergeben werden. |
Ausgaben |
Keiner oder System.Management.Automation.PSVariable Wenn Sie den PassThru-Parameter verwenden, generiert Clear-Variable ein System.Management.Automation.PSVariable-Objekt, das die gelöschte Variable darstellt. Andernfalls wird von diesem Cmdlet keine Ausgabe generiert. |
Hinweise
Um eine Variable gemeinsam mit ihrem Wert zu löschen, verwenden Sie Remove-Variable oder Remove-Item.
Mit Clear-Variable werden die Werte von Variablen, die als Konstanten festgelegt sind oder deren Besitzer das System ist, nicht gelöscht, auch nicht bei Verwendung des -Force-Parameters.
Wenn die zu löschende Variable nicht vorhanden ist, bleibt das Cmdlet ohne Auswirkungen. Es wird keine Variable mit dem Wert NULL erstellt.
Sie können auch über den integrierten Alias "clv" auf Clear-Variable verweisen. Weitere Informationen finden Sie unter "about_Aliases".
Beispiel 1
C:\PS>clear-variable my* -global
Beschreibung
-----------
Mit diesem Befehl wird der Wert der globalen Variablen gelöscht, die mit "my" beginnen.
Beispiel 2
C:\PS>$a=3
C:\PS>&{ clear-variable a }
C:\PS>$a
3
Beschreibung
-----------
Mit diesen Befehlen wird veranschaulicht, dass durch das Löschen einer Variablen in einem untergeordneten Bereich der Wert im übergeordneten Bereich nicht gelöscht wird. Mit dem ersten Befehl wird der Wert der Variablen "$a" auf "3" festgelegt. Der zweite Befehl verwendet den Aufrufoperator (&) zum Ausführen des Befehls "Clear-Variable" in einem neuen Bereich. Die Variable wird im untergeordneten Bereich gelöscht (obwohl sie nicht vorhanden war), doch nicht im lokalen Bereich. Mit dem dritten Befehl, der den Wert von "$a" abruft, wird gezeigt, dass der Wert "3" nicht gelöscht wurde.
Beispiel 3
C:\PS>clear-variable -name processes
Beschreibung
-----------
Mit diesem Befehl wird der Wert der Variablen "$processes" gelöscht. Die Variable "$processes" ist noch vorhanden, doch ihr Wert ist NULL.