Supprime la valeur d'une variable.
Syntaxe
Clear-Variable [-Name] <string[]> [-Exclude <string[]>] [-Force] [-Include <string[]>] [-PassThru] [-Scope <string>] [-Confirm] [-WhatIf] [<CommonParameters>]
Description
L'applet de commande Clear-Variable supprime les données stockées dans une variable, mais ne supprime pas la variable. En conséquence, la valeur de la variable est NULL (vide). Si la variable a des données spécifiées ou un type d'objet, Clear-Variable conserve le type d'objet stocké dans la variable.
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 d'effacer une variable même si elle est en lecture seule. L'applet de commande ne peut pas effacer les constantes, 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[]>
Efface 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 à effacer. Les caractères génériques sont autorisés. Ce paramètre est obligatoire, mais 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 |
-PassThru
Retourne un objet représentant la variable effacée. Par défaut, cette applet de commande ne génère aucune sortie.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
false |
|
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 |
-Confirm
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 |
Aucun Vous ne pouvez pas diriger d'objets vers Clear-Variable. |
|
Sorties |
Aucun ou System.Management.Automation.PSVariable Lorsque vous utilisez le paramètre PassThru, Clear-Variable génère un objet System.Management.Automation.PSVariable qui représente la variable effacée. Sinon, cette applet de commande ne génère aucune sortie. |
Remarques
Pour supprimer une variable avec sa valeur, utilisez Remove-Variable ou Remove-Item.
Clear-Variable ne supprimera pas les valeurs des variables qui sont définies en tant que constantes ou qui appartiennent au 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. Il 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.
Exemple 1
C:\PS>clear-variable my* -global Description ----------- Cette commande supprime la valeur des variables globales par qui commencent par « my ».
Exemple 2
C:\PS>$a=3
C:\PS>&{ clear-variable a }
C:\PS>$a
3
Description
-----------
Ces commandes montrent que l'effacement d'une variable dans une portée enfant n'efface pas la valeur dans la portée parente. La première commande définit la valeur de la variable $a sur « 3 ». La deuxième commande utilise l'opérateur d'appel (&) pour exécuter une commande Clear-Variable dans une nouvelle portée. La variable est effacée dans la portée enfant (alors même qu'elle n'existait pas), mais elle n'est pas effacée dans la portée locale. La troisième commande, qui obtient la valeur de $a, indique que la valeur « 3 » est non affectée.
Exemple 3
C:\PS>clear-variable -name processes Description ----------- Cette commande supprime la valeur de la variable $processes. La variable $processes existe encore, mais la valeur est nulle.
Voir aussi