Supprime une variable et sa valeur.
Syntaxe
Remove-Variable [-Name] <string[]> [-Exclude <string[]>] [-Force] [-Include <string[]>] [-Scope <string>] [-Confirmer] [-WhatIf] [<CommonParameters>]
Description
L'applet de commande Remove-Variable supprime une variable et sa valeur de la portée dans laquelle elle est définie, telle que la session actuelle. Vous ne pouvez pas utiliser cette applet de commande pour supprimer des variables qui sont définies comme constantes ou celles qui sont la propriété du système.
Paramètres
-Exclude <string[]>
Omet les éléments spécifiés. La valeur de ce paramètre qualifie le paramètre Name. Entrez un élément ou un modèle de nom, tel que « s* ». Les caractères génériques sont autorisés.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-Force
Permet à l'applet de commande de supprimer une variable même si elle est en lecture seule. L'applet de commande ne peut pas supprimer une constante, même à l'aide du paramètre Force.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-Include <string[]>
Supprime uniquement les éléments spécifiés. La valeur de ce paramètre qualifie le paramètre Name. Entrez un élément ou un modèle de nom, tel que « s* ». Les caractères génériques sont autorisés.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-Name <string[]>
Spécifie le nom de la variable à supprimer. Le nom de paramètre (« Name ») est facultatif.
|
Obligatoire ? |
true |
|
Position ? |
1 |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
true (ByPropertyName) |
|
Accepter les caractères génériques ? |
false |
-Scope <string>
Spécifie la portée dans laquelle cet alias est valide. Les valeurs valides sont « Global », « Local » ou « Script », ou un nombre relatif à la portée actuelle (0 jusqu'au nombre de portées, où 0 est la portée actuelle et 1 son parent). « Local » est la valeur par défaut. Pour plus d'informations, consultez about_Scopes.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-Confirmer
Vous invite à confirmer l'exécution de la commande.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-WhatIf
Décrit le résultat que vous obtiendriez en exécutant la commande, sans réellement l'exécuter.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
<CommonParameters>
Cette applet de commande prend en charge les paramètres courants : -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer et -OutVariable. Pour plus d'informations, consultez about_Commonparameters.
Entrées et sorties
Le type d'entrée est le type des objets que vous pouvez diriger vers l'applet de commande. Le type de retour est le type des objets que l'applet de commande retourne.
|
Entrées |
System.Management.Automation.PSVariable Vous pouvez diriger un objet variable vers Remove-Variable. |
|
Sorties |
Aucun Cette applet de commande ne retourne aucune sortie. |
Remarques
Les modifications affectent uniquement la portée actuelle, telle qu'une session. Pour supprimer une variable de toutes les sessions, ajoutez une commande Remove-Variable à votre profil Windows PowerShell.
Vous pouvez également faire référence à RemoveVariable par son alias intégré, « rv ». Pour plus d'informations, consultez about_Aliases.
Exemple 1
C:\PS>remove-variable Smp Description ----------- Cette commande supprime la variable $Smp.
Voir aussi