Partager via

Clear-Variable

  • Référence
Module:
Microsoft.PowerShell.Utility

Supprime la valeur d’une variable.

Syntaxe

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

Description

La cmdlet Clear-Variable supprime les données stockées dans une variable, mais elle ne supprime pas la variable. Par conséquent, la valeur de la variable est NULL (vide). Si la variable a un type de données ou d’objet spécifié, cette applet de commande conserve le type de l’objet stocké dans la variable.

Exemples

Exemple 1 : Supprimer la valeur des variables globales qui commencent par une chaîne de recherche

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

Cette commande supprime la valeur des variables globales qui ont des noms qui commencent par moi.

Exemple 2 : Effacer une variable dans une étendue enfant, mais pas l’étendue parente

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

Ces commandes montrent que l’effacement d’une variable dans une étendue enfant n’efface pas la valeur dans l’étendue parente. La première commande définit la valeur de la variable $A à 3. La deuxième commande utilise l’opérateur Invoke (&) pour exécuter la commande Clear-Variable dans une nouvelle étendue. La variable est effacée dans l’étendue enfant (bien qu’elle n’existe pas), mais elle n’est pas effacée dans l’étendue locale. La troisième commande, qui obtient la valeur de $A, indique que la valeur 3 n’est pas affectée.

Exemple 3 : Supprimer la valeur de la variable spécifiée

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

Cette commande supprime la valeur de la variable nommée Process. Une fois l’applet de commande terminée, la variable nommée Processus existe toujours, mais la valeur est Null.

Paramètres

-Confirm

Vous invite à confirmer avant d’exécuter l’applet de commande.

Type:SwitchParameter
Alias:cf
Position:Named
Valeur par défaut:False
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Exclude

Spécifie un tableau d’éléments omis par cette applet de commande dans l’opération. La valeur de ce paramètre qualifie le paramètre Name. Entrez un élément de nom ou un modèle, tel que « s* ». Les caractères génériques sont autorisés.

Type:String[]
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:True

-Force

Permet à l’applet de commande d’effacer une variable même si elle est en lecture seule. Même en utilisant le paramètre Force, l’applet de commande ne peut pas effacer les constantes.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Include

Spécifie un tableau d’éléments inclus dans cette applet de commande dans l’opération. La valeur de ce paramètre qualifie le paramètre Name. Entrez un élément de nom ou un modèle, tel que « s* ». Les caractères génériques sont autorisés.

Type:String[]
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:True

-Name

Spécifie le nom de la variable à effacer. Les caractères génériques sont autorisés. Ce paramètre est obligatoire, mais le nom du paramètre (« Name ») est facultatif.

Type:String[]
Position:0
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:True

-PassThru

Retourne un objet représentant l’élément avec lequel vous travaillez. Par défaut, cette applet de commande ne génère aucune sortie.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Scope

Spécifie l’étendue dans laquelle cet alias est valide.

Les valeurs acceptables pour ce paramètre sont les suivantes :

  • Global
  • Local
  • Script

Vous pouvez également utiliser un nombre par rapport à l’étendue actuelle (0 au nombre d’étendues, où 0 est l’étendue actuelle et 1 est son parent). Local est la valeur par défaut. Pour plus d’informations, consultez about_Scopes.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-WhatIf

Affiche ce qui se passerait si l’applet de commande s’exécute. L’applet de commande n’est pas exécutée.

Type:SwitchParameter
Alias:wi
Position:Named
Valeur par défaut:False
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

Entrées

None

Vous ne pouvez pas diriger les objets vers cette applet de commande.

Sorties

None or System.Management.Automation.PSVariable

Lorsque vous utilisez le paramètre passThru , cette applet de commande génère un objet System.Management.Automation.PSVariable représentant la variable effacée. Sinon, cette applet de commande ne génère aucune sortie.

Notes

  • Pour supprimer une variable, ainsi que sa valeur, utilisez Remove-Variable ou Remove-Item.

    Cette applet de commande ne supprime pas les valeurs des variables définies en tant que constantes ou détenues par le système, même si vous utilisez le paramètre Force .

    Si la variable que vous effacez n’existe pas, l’applet de commande n’a aucun effet. Elle ne crée pas de variable avec une valeur Null.

    Vous pouvez également faire référence à Clear-Variable par son alias intégré, clv. Pour plus d’informations, consultez about_Aliases.