Clear-Item

  • Référence
Module:
Microsoft.PowerShell.Management

Efface le contenu d’un élément, mais ne supprime pas l’élément.

Syntax

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 Clear-Item de commande efface le contenu d’un élément, mais il ne supprime pas l’élément. Par exemple, l’applet Clear-Item de commande 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 et est valide, mais sa valeur est définie sur $null. Le nom de la variable est préfixé pour Variable: 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 Clear-Item commande.

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 seulement après vous avoir invité à confirmer votre intention. Il ne supprime pas la sous-clé « MyKey » ou n’affecte aucune autre clé ou entrée de Registre. Vous pouvez utiliser les paramètres Include et Exclude pour identifier des clés de Registre spécifiques, mais non des entrées du Registre.

  • Pour supprimer des entrées de Registre spécifiques, utilisez l'applet de commande Remove-ItemProperty.
  • Pour supprimer la valeur d’une entrée de Registre, utilisez le Clear-ItemProperty cmdlet.
Clear-Item HKLM:\Software\MyCompany\MyKey -Confirm

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

-Credential

Notes

Ce paramètre n’est pris en charge par aucun fournisseur installé 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
Default value:Current user
Required:False
Accept pipeline input:True
Accept wildcard characters: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, par exemple *.txt. Les caractères génériques sont autorisés. Le paramètre Exclude est efficace uniquement lorsque la commande inclut le contenu d’un élément, par C:\Windows\*exemple, où le caractère générique spécifie le contenu du C:\Windows répertoire.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-Filter

Spécifie un filtre pour qualifier le paramètre Path . Le fournisseur FileSystem est le seul fournisseur PowerShell installé qui prend en charge l’utilisation de filtres. Vous trouverez la syntaxe du langage de filtre FileSystem dans about_Wildcards. Les filtres sont plus efficaces que d’autres paramètres, car le fournisseur les applique lorsque l’applet de commande obtient les objets plutôt que d’avoir PowerShell filtrer les objets une fois qu’ils sont récupérés.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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 des constantes. L'implémentation est différente d'un fournisseur à l'autre. 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 Force est utilisé.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Include

Spécifie, en tant que 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, par exemple "*.txt". Les caractères génériques sont autorisés. Le paramètre Include est efficace uniquement lorsque la commande inclut le contenu d’un élément, par C:\Windows\*exemple, où le caractère générique spécifie le contenu du C:\Windows répertoire.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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é en tant que caractère générique. Si le chemin d’accès inclut des caractères d’échappement, mettez-le entre des guillemets simples. Les guillemets simples indiquent à PowerShell de ne pas interpréter les caractères comme séquences d’échappement.

Pour plus d’informations, consultez about_Quoting_Rules.

Type:String[]
Aliases:PSPath, LP
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Path

Spécifie le chemin d'accès aux éléments qui sont effacés. Les caractères génériques sont autorisés. Ce paramètre est obligatoire, mais le chemin d’accès au nom du paramètre est facultatif.

Type:String[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:True

-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

String

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 Clear-Item de commande est prise en charge uniquement par plusieurs fournisseurs PowerShell, notamment l’alias, l’environnement, la fonction, le Registre 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, tapez Get-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 le Clear-Content.