Clear-Item
Efface le contenu d’un élément, mais ne supprime pas l’élément.
Syntaxe
Clear-Item
[-Path] <String[]>
[-Force]
[-Filter <String>]
[-Include <String[]>]
[-Exclude <String[]>]
[-Credential <PSCredential>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Clear-Item
-LiteralPath <String[]>
[-Force]
[-Filter <String>]
[-Include <String[]>]
[-Exclude <String[]>]
[-Credential <PSCredential>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
L’applet de commande Clear-Item
efface le contenu d’un élément, mais il ne supprime pas l’élément.
Par exemple, l’applet de commande Clear-Item
peut supprimer la valeur d’une variable, mais elle ne supprime pas la variable. La valeur utilisée pour représenter un élément effacé est définie par chaque fournisseur PowerShell.
Cette applet de commande est similaire à Clear-Content
, mais elle fonctionne sur les alias et les variables, au lieu de fichiers.
Exemples
Exemple 1 : Effacer la valeur d’une variable
Cette commande efface la valeur de la variable nommée TestVar1
.
La variable reste valide, mais sa valeur est définie sur $null
.
Le nom de la variable est préfixé par Variable:
pour indiquer le fournisseur de variables PowerShell.
Les autres commandes montrent que, pour obtenir le même résultat, vous pouvez basculer vers le lecteur powerShell Variable:
, puis exécuter la commande Clear-Item
.
Clear-Item Variable:TestVar1
Set-Location Variable:
PS Variable:\> Clear-Item TestVar1
Exemple 2 : Effacer toutes les entrées de Registre
Cette commande efface toutes les entrées de Registre dans la sous-clé « MyKey », mais uniquement après vous avoir invité à confirmer votre intention. Elle ne supprime pas la sous-clé « MyKey » ou n’affecte aucune autre clé ou entrée de Registre. Vous pouvez utiliser les paramètres Inclure et Exclure des paramètres pour identifier des clés de Registre particulières, mais vous ne pouvez pas les utiliser pour identifier les entrées du Registre.
- Pour supprimer des entrées de Registre particulières, utilisez l’applet de commande
Remove-ItemProperty
. - Pour supprimer la valeur d’une entrée de Registre, utilisez la
Clear-ItemProperty cmdlet
.
Clear-Item HKLM:\Software\MyCompany\MyKey -Confirm
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 |
-Credential
Note
Ce paramètre n’est pas pris en charge par les fournisseurs installés avec PowerShell. Pour emprunter l’identité d’un autre utilisateur ou élever vos informations d’identification lors de l’exécution de cette applet de commande, utilisez Invoke-Command.
Type: | PSCredential |
Position: | Named |
Valeur par défaut: | Current user |
Obligatoire: | False |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-Exclude
Spécifie, en tant que tableau de chaînes, un élément ou des éléments que cette applet de commande exclut dans l’opération. La valeur de ce paramètre qualifie le paramètre Path. Entrez un élément ou un modèle de chemin d’accès, tel que *.txt
. Les caractères génériques sont autorisés. Le paramètre Exclure est efficace uniquement lorsque la commande inclut le contenu d’un élément, tel que C:\Windows\*
, où le caractère générique spécifie le contenu du répertoire C:\Windows
.
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 |
-Filter
Spécifie un filtre pour qualifier le paramètre Path. Le fournisseur FileSystem
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
Indique que l’applet de commande efface les éléments qui ne peuvent pas être modifiés autrement, tels que les alias en lecture seule. L’applet de commande ne peut pas effacer les constantes. L’implémentation varie du fournisseur au fournisseur. Pour plus d’informations, consultez about_Providers. L’applet de commande ne peut pas remplacer les restrictions de sécurité, même lorsque le paramètre Forcer est utilisé.
Type: | SwitchParameter |
Position: | Named |
Valeur par défaut: | False |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-Include
Spécifie, sous la forme d’un tableau de chaînes, un élément ou des éléments inclus dans l’opération. La valeur de ce paramètre qualifie le paramètre Path. Entrez un élément ou un modèle de chemin d’accès, tel que "*.txt"
. Les caractères génériques sont autorisés. Le paramètre Include
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 |
-LiteralPath
Spécifie un chemin d’accès à un ou plusieurs emplacements. La valeur de LiteralPath est utilisée exactement comme elle est typée. Aucun caractère n’est interprété comme des caractères génériques. Si le chemin inclut des caractères d’échappement, placez-le entre guillemets simples. Les guillemets simples indiquent à PowerShell de ne pas interpréter de caractères comme séquences d’échappement.
Pour plus d’informations, consultez about_Quoting_Rules.
Type: | String[] |
Alias: | PSPath, LP |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | True |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-Path
Spécifie le chemin d’accès aux éléments effacés. Les caractères génériques sont autorisés. Ce paramètre est obligatoire, mais le nom du paramètre Path 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 |
-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
Vous pouvez diriger une chaîne de chemin vers cette applet de commande.
Sorties
None
Cette applet de commande ne génère aucune sortie.
Notes
- L’applet de commande
est prise en charge uniquement par plusieurs fournisseurs PowerShell, notamment l'd’alias , l’environnement , Function ,Registry et les fournisseurs de variables. Par conséquent, vous pouvez utiliser Clear-Item
pour supprimer le contenu des éléments dans les espaces de noms du fournisseur. Pour répertorier les fournisseurs disponibles dans votre session, tapezGet-PsProvider
. Pour plus d’informations, consultez about_Providers. - Vous ne pouvez pas utiliser
Clear-Item
pour supprimer le contenu d’un fichier, car le fournisseur PowerShell FileSystem ne prend pas en charge cette applet de commande. Pour effacer les fichiers, utilisez leClear-Content
.