Clear-Variable

Modul:

Microsoft.PowerShell.Utility Module

Odstraní hodnotu proměnné.

Syntax

Default (Výchozí)

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 neodstraní proměnnou. 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

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

$a=3
&{ Clear-Variable a }
$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 pomocí operátoru invoke (&) spustí příkaz 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é

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 cmdletu vás vyzve k potvrzení.

Vlastnosti parametru

Typ:	SwitchParameter
Default value:	False
Podporuje zástupné znaky:	False
DontShow:	False
Aliasy:	viz

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	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é symboly.

Vlastnosti parametru

Typ:	String[]
Default value:	None
Podporuje zástupné znaky:	True
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-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.

Vlastnosti parametru

Typ:	SwitchParameter
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	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é symboly.

Vlastnosti parametru

Typ:	String[]
Default value:	None
Podporuje zástupné znaky:	True
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-Name

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

Vlastnosti parametru

Typ:	String[]
Default value:	None
Podporuje zástupné znaky:	True
DontShow:	False

Sady parametrů

(All)

Position:	0
Povinné:	True
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	True
Hodnota ze zbývajících argumentů:	False

-PassThru

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

Vlastnosti parametru

Typ:	SwitchParameter
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-Scope

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

Přijatelné hodnoty pro tento parametr jsou:

• Global
• Local
• Script

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 části about_Scopes.

Vlastnosti parametru

Typ:	String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-WhatIf

Ukazuje, co se stane, když se příkaz spustí. Příkazový modul nebyl spuštěn.

Vlastnosti parametru

Typ:	SwitchParameter
Default value:	False
Podporuje zástupné znaky:	False
DontShow:	False
Aliasy:	Wi

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

CommonParameters

Tato rutina podporuje běžné parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction a -WarningVariable. Další informace najdete v about_CommonParameters.

Vstupy

None

Do tohoto cmdletu nemůžete předávat objekty.

Výstupy

None

Ve výchozím nastavení tato rutina nevrací žádný výstup.

PSVariable

Pokud použijete parametr PassThru, vrátí tato rutina PSVariable objekt představující nezaškrtnutou proměnnou.

Poznámky

PowerShell obsahuje následující aliasy pro Clear-Variable:

• Všechny platformy:

  • clv

• 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.

Související odkazy

• Get-Variable
• Nová-Proměnná
• Odebrat proměnnou
• Nastavit proměnnou