Clear-Variable

  • Odwołanie
Moduł:
Microsoft.PowerShell.Utility

Usuwa wartość zmiennej.

Składnia

Clear-Variable
     [-Name] <String[]>
     [-Include <String[]>]
     [-Exclude <String[]>]
     [-Force]
     [-PassThru]
     [-Scope <String>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Opis

Polecenie Clear-Variable cmdlet usuwa dane przechowywane w zmiennej, ale nie usuwa zmiennej. W związku z tym wartość zmiennej ma wartość NULL (pusta). Jeśli zmienna ma określony typ danych lub obiektu, to polecenie cmdlet zachowuje typ obiektu przechowywanego w zmiennej.

Przykłady

Przykład 1. Usuwanie wartości zmiennych globalnych rozpoczynających się ciągiem wyszukiwania

Clear-Variable my* -Scope Global

To polecenie usuwa wartość zmiennych globalnych, które mają nazwy rozpoczynające się od mojego.

Przykład 2. Wyczyść zmienną w zakresie podrzędnym, ale nie w zakresie nadrzędnym

$a=3
&{ Clear-Variable a }
$a

3

Te polecenia pokazują, że wyczyszczenie zmiennej w zakresie podrzędnym nie powoduje wyczyszczenia wartości w zakresie nadrzędnym. Pierwsze polecenie ustawia wartość zmiennej $a na 3. Drugie polecenie używa operatora invoke (&), aby uruchomić Clear-Variable polecenie w nowym zakresie. Zmienna jest czyszczone w zakresie podrzędnym (chociaż nie istnieje), ale nie jest czyszczone w zakresie lokalnym. Trzecie polecenie, które pobiera wartość $a, pokazuje, że wartość 3 nie ma wpływu.

Przykład 3. Usuwanie wartości określonej zmiennej

Clear-Variable -Name "Processes"

To polecenie usuwa wartość zmiennej o nazwie Procesy. Po zakończeniu operacji polecenia cmdlet zmienna o nazwie Procesy nadal istnieje, ale wartość ma wartość null.

Parametry

-Confirm

Monituje o potwierdzenie przed uruchomieniem polecenia cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Exclude

Określa tablicę elementów pomijanych przez to polecenie cmdlet w operacji. Wartość tego parametru kwalifikuje parametr Name . Wprowadź element nazwy lub wzorzec, taki jak "s*". Dozwolone są symbole wieloznaczne.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-Force

Umożliwia poleceniem cmdlet wyczyszczenie zmiennej nawet wtedy, gdy jest tylko do odczytu. Nawet przy użyciu parametru Force polecenie cmdlet nie może wyczyścić stałych.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Include

Określa tablicę elementów, które zawiera to polecenie cmdlet w operacji. Wartość tego parametru kwalifikuje parametr Name . Wprowadź element nazwy lub wzorzec, taki jak "s*". Dozwolone są symbole wieloznaczne.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-Name

Określa nazwę zmiennej do wyczyszczenia. Dozwolone są symbole wieloznaczne. Ten parametr jest wymagany, ale nazwa parametru jest opcjonalna.

Type:String[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:True

-PassThru

Zwraca obiekt reprezentujący element, z którym pracujesz. Domyślnie to polecenie cmdlet nie generuje żadnych danych wyjściowych.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Scope

Określa zakres, w którym ten alias jest prawidłowy.

Dopuszczalne wartości tego parametru to:

  • Global
  • Local
  • Script

Można również użyć liczby względem bieżącego zakresu (0 przez liczbę zakresów, gdzie 0 jest bieżącym zakresem, a 1 jest jego elementem nadrzędnym). Wartość lokalna to wartość domyślna. Aby uzyskać więcej informacji, zobacz about_Scopes.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Pokazuje, co się stanie po uruchomieniu polecenia cmdlet. Polecenie cmdlet nie zostało uruchomione.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Dane wejściowe

None

Nie można potokować obiektów do tego polecenia cmdlet.

Dane wyjściowe

None

Domyślnie to polecenie cmdlet nie zwraca żadnych danych wyjściowych.

PSVariable

Jeśli używasz parametru PassThru , to polecenie cmdlet zwraca obiekt PSVariable reprezentujący wyczyszczonej zmiennej.

Uwagi

Program PowerShell zawiera następujące aliasy dla programu Clear-Variable:

  • Wszystkie platformy:

    • clv

  • Aby usunąć zmienną wraz z jej wartością, użyj polecenia Remove-Variable lub Remove-Item.

    To polecenie cmdlet nie usuwa wartości zmiennych, które są ustawiane jako stałe lub należące do systemu, nawet jeśli używasz parametru Force .

    Jeśli zmienna, która jest czyszcząca, nie istnieje, polecenie cmdlet nie ma efektu. Nie tworzy zmiennej z wartością null.