Clear-Variable
Supprime la valeur d'une variable.
Syntax
Clear-Variable
[-Name] <String[]>
[-Include <String[]>]
[-Exclude <String[]>]
[-Force]
[-PassThru]
[-Scope <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
L’applet Clear-Variable
de commande 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 dont les noms commencent par my.
Exemple 2 : Effacer une variable dans une étendue enfant, mais pas dans l’étendue parente
$a=3
&{ Clear-Variable a }
$a
3
Ces commandes montrent qu'effacer 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 Clear-Variable
commande dans une nouvelle étendue. La variable est effacée dans l'étendue enfant (même si elle n'existait 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 Processus. Une fois l’applet de commande terminée l’opération, la variable nommée Processus existe toujours, mais la valeur est null.
Paramètres
-Confirm
Vous demande une confirmation avant d’exécuter l’applet de commande.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Exclude
Spécifie un tableau d’éléments que cette applet de commande omet dans l’opération. 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.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | 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 des constantes.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Include
Spécifie un tableau d’éléments que cette applet de commande inclut dans l’opération. 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.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | 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 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | True |
-PassThru
Retourne un objet représentant l’élément que vous utilisez. Par défaut, cette applet de commande ne génère aucun résultat.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Scope
Spécifie l'étendue dans laquelle cet alias est valide.
Les valeurs valides pour ce paramètre sont :
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 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Montre ce qui se passe en cas d’exécution de l’applet de commande. L’applet de commande n’est pas exécutée.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Entrées
None
Vous ne pouvez pas rediriger des 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
ouRemove-Item
.Cette applet de commande ne supprime 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. Elle ne crée pas de variable avec une valeur null.
Vous pouvez également faire référence à par
Clear-Variable
son alias intégré,clv
. Pour plus d’informations, consultez about_Aliases.