Clear-Variable
Supprime la valeur d’une variable.
Syntaxe
Default (Par défaut)
Clear-Variable
[-Name] <String[]>
[-Include <String[]>]
[-Exclude <String[]>]
[-Force]
[-PassThru]
[-Scope <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
L’applet de commande 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
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
$a = 3
&{ Clear-Variable a }
$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 sur 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
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.
Propriétés du paramètre
| Type: | SwitchParameter |
| Valeur par défaut: | False |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
| Alias: | cf |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | 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.
Propriétés du paramètre
| Type: | String[] |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | True |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-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.
Propriétés du paramètre
| Type: | SwitchParameter |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | 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.
Propriétés du paramètre
| Type: | String[] |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | True |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-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 Nom est facultatif.
Propriétés du paramètre
| Type: | String[] |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | True |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | 0 |
| Obligatoire: | True |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | True |
| Valeur des arguments restants: | False |
-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.
Propriétés du paramètre
| Type: | SwitchParameter |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-Scope
Spécifie l’étendue dans laquelle cet alias est valide.
Les valeurs acceptables pour ce paramètre sont les suivantes :
GlobalLocalScript
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.
Propriétés du paramètre
| Type: | String |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-WhatIf
Affiche ce qui se passerait si l’applet de commande s’exécute. L’applet de commande ne s’exécute pas.
Propriétés du paramètre
| Type: | SwitchParameter |
| Valeur par défaut: | False |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
| Alias: | Wi |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
CommonParameters
Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.
Entrées
None
Vous ne pouvez pas diriger les objets vers cette applet de commande.
Sorties
None
Par défaut, cette applet de commande ne retourne aucune sortie.
PSVariable
Lorsque vous utilisez le paramètre PassThru, cette applet de commande retourne un objet PSVariable représentant la variable effacée.
Notes
PowerShell inclut les alias suivants pour Clear-Variable:
Toutes les plateformes :
clv
Pour supprimer une variable, ainsi que sa valeur, utilisez
Remove-VariableouRemove-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.
