Sdílet prostřednictvím

Clear-Variable

  • Reference
Modul:
Microsoft.PowerShell.Utility

Odstraní hodnotu proměnné.

Syntaxe

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

Description

Rutina Clear-Variable odstraní data uložená v proměnné, ale proměnnou neodstraní. Výsledkem je, že hodnota proměnné je NULL (prázdná). Pokud má proměnná zadaný typ dat nebo objektu, tato rutina zachová typ objektu uloženého v proměnné.

Příklady

Příklad 1: Odebrání hodnoty globálních proměnných, které začínají vyhledávacím řetězcem

PS C:\> Clear-Variable my* -Scope Global

Tento příkaz odebere hodnotu globálních proměnných, které mají názvy začínající mými.

Příklad 2: Vymazání proměnné v podřízené oblasti, ale ne nadřazeného oboru

PS C:\> $a=3
PS C:\> &{ Clear-Variable a }
PS C:\> $a
3

Tyto příkazy ukazují, že vymazání proměnné v podřízené oblasti neujasní hodnotu v nadřazené oblasti. První příkaz nastaví hodnotu proměnné $A na 3. Druhý příkaz používá operátor vyvolání (&) ke spuštění příkazu Clear-Variable v novém oboru. Proměnná se vymaže v podřízené oblasti (i když neexistuje), ale není v místním oboru vymazána. Třetí příkaz, který získá hodnotu $A, ukazuje, že hodnota 3 není ovlivněna.

Příklad 3: Odstranění hodnoty zadané proměnné

PS C:\> Clear-Variable -Name "Processes"

Tento příkaz odstraní hodnotu proměnné s názvem Procesy. Jakmile rutina operaci dokončí, proměnná s názvem Procesy stále existuje, ale hodnota má hodnotu null.

Parametry

-Confirm

Před spuštěním rutiny vás vyzve k potvrzení.

Typ:SwitchParameter
Aliasy:cf
Position:Named
Default value:False
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-Exclude

Určuje pole položek, které tato rutina v operaci vynechá. Hodnota tohoto parametru kvalifikuje parametr Name. Zadejte element nebo vzor názvu, například "s*". Jsou povoleny zástupné cardy.

Typ:String[]
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:True

-Force

Umožňuje rutině vymazat proměnnou i v případě, že je určená jen pro čtení. I pomocí parametru Force nemůže rutina vymazat konstanty.

Typ:SwitchParameter
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-Include

Určuje pole položek, které tato rutina zahrnuje v operaci. Hodnota tohoto parametru kvalifikuje parametr Name. Zadejte element nebo vzor názvu, například "s*". Jsou povoleny zástupné cardy.

Typ:String[]
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:True

-Name

Určuje název proměnné, která se má vymazat. Jsou povoleny zástupné cardy. Tento parametr je povinný, ale název parametru ("Name") je volitelný.

Typ:String[]
Position:0
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:True
Přijmout zástupné znaky:True

-PassThru

Vrátí objekt představující položku, se kterou pracujete. Ve výchozím nastavení tato rutina negeneruje žádný výstup.

Typ:SwitchParameter
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-Scope

Určuje obor, ve kterém je tento alias platný.

Přijatelné hodnoty pro tento parametr jsou:

  • Globální
  • Místní
  • Skript

Můžete také použít číslo relativní k aktuálnímu oboru (0 až počet oborů, kde 0 je aktuální obor a 1 je jeho nadřazený). Místní je výchozí hodnota. Další informace najdete v tématu about_Scopes.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-WhatIf

Ukazuje, co se stane, když se rutina spustí. Rutina se nespustí.

Typ:SwitchParameter
Aliasy:wi
Position:Named
Default value:False
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

Vstupy

None

Do této rutiny nelze vést objekty.

Výstupy

None or System.Management.Automation.PSVariable

Pokud použijete parametr PassThru, tato rutina vygeneruje objekt System.Management.Automation.PSVariable představující nezaškrtnutou proměnnou. Jinak tato rutina negeneruje žádný výstup.

Poznámky

  • Pokud chcete odstranit proměnnou spolu s její hodnotou, použijte Remove-Variable nebo Remove-Item.

    Tato rutina neodstraní hodnoty proměnných, které jsou nastaveny jako konstanty nebo vlastní systém, i když použijete parametr Force.

    Pokud proměnná, kterou vymažete, neexistuje, rutina nemá žádný vliv. Nevytvoří proměnnou s hodnotou null.

    Můžete také odkazovat na Clear-Variable jeho předdefinovaný alias clv. Další informace najdete v tématu about_Aliases.