Clear-Variable

  • Referens
Modul:
Microsoft.PowerShell.Utility

Tar bort värdet för en variabel.

Syntax

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

Description

Cmdleten Clear-Variable tar bort data som lagras i en variabel, men variabeln tas inte bort. Därför är värdet för variabeln NULL (tomt). Om variabeln har en angiven data- eller objekttyp bevarar den här cmdleten typen av objekt som lagras i variabeln.

Exempel

Exempel 1: Ta bort värdet för globala variabler som börjar med en söksträng

Clear-Variable my* -Scope Global

Det här kommandot tar bort värdet för globala variabler som har namn som börjar med min.

Exempel 2: Rensa en variabel i ett underordnat omfång men inte det överordnade omfånget

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

3

Dessa kommandon visar att rensning av en variabel i ett underordnat omfång inte rensar värdet i det överordnade omfånget. Det första kommandot anger värdet för variabeln $a till 3. Det andra kommandot använder operatorn invoke (&) för att köra Clear-Variable kommandot i ett nytt omfång. Variabeln rensas i det underordnade omfånget (även om den inte fanns), men den rensas inte i det lokala omfånget. Det tredje kommandot, som hämtar värdet $a, visar att värdet 3 inte påverkas.

Exempel 3: Ta bort värdet för den angivna variabeln

Clear-Variable -Name "Processes"

Det här kommandot tar bort värdet för variabeln med namnet Processes. När cmdleten har slutfört åtgärden finns variabeln med namnet Processes fortfarande, men värdet är null.

Parametrar

-Confirm

Uppmanar dig att bekräfta innan du kör cmdleten.

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

-Exclude

Anger en matris med objekt som denna cmdlet utelämnar i åtgärden. Värdet för den här parametern kvalificerar parametern Name . Ange ett namnelement eller mönster, till exempel "s*". Jokertecken tillåts.

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

-Force

Tillåter att cmdleten rensar en variabel även om den är skrivskyddad. Även om du använder force-parametern kan cmdleten inte rensa konstanter.

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

-Include

Anger en matris med objekt som den här cmdleten innehåller i åtgärden. Värdet för den här parametern kvalificerar parametern Name . Ange ett namnelement eller mönster, till exempel "s*". Jokertecken tillåts.

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

-Name

Anger namnet på variabeln som ska rensas. Jokertecken tillåts. Den här parametern krävs, men parameternamnet Name är valfritt.

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

-PassThru

Returnerar ett objekt som representerar det objekt som du arbetar med. Som standard genererar denna cmdlet inga utdata.

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

-Scope

Anger i vilket omfång det här aliaset är giltigt.

De acceptabla värdena för den här parametern är:

  • Global
  • Local
  • Script

Du kan också använda ett tal i förhållande till det aktuella omfånget (0 genom antalet omfång, där 0 är det aktuella omfånget och 1 är dess överordnade). Lokal är standardinställningen. Mer information finns i about_Scopes.

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

-WhatIf

Visar vad som skulle hända om cmdleten kördes. Cmdleten körs inte.

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

Indata

None

Du kan inte skicka objekt till den här cmdleten.

Utdata

None or System.Management.Automation.PSVariable

När du använder parametern PassThru genererar den här cmdleten ett System.Management.Automation.PSVariable-objekt som representerar den rensade variabeln. Annars genererar denna cmdlet inga utdata.

Kommentarer

  • Om du vill ta bort en variabel, tillsammans med dess värde, använder du Remove-Variable eller Remove-Item.

    Den här cmdleten tar inte bort värdena för variabler som anges som konstanter eller ägs av systemet, även om du använder parametern Force .

    Om variabeln som du rensar inte finns har cmdleten ingen effekt. Den skapar inte en variabel med ett null-värde.

    Du kan också referera till Clear-Variable med dess inbyggda alias, clv. Mer information finns i about_Aliases.