Clear-Item

Supprime le contenu d'un élément, mais ne supprime pas l'élément.

Syntaxe

Clear-Item [-LiteralPath] <string[]> [-Credential <PSCredential>] [-Exclude <string[]>] [-Filter <string>] [-Force] [-Include <string[]>] [-Confirm] [-WhatIf] [-UseTransaction] [<CommonParameters>]

Clear-Item [-Path] <string[]> [-Credential <PSCredential>] [-Exclude <string[]>] [-Filter <string>] [-Force] [-Include <string[]>] [-Confirm] [-WhatIf] [-UseTransaction] [<CommonParameters>]

Description

L'applet de commande Clear-Item supprime la valeur d'un élément, mais elle ne supprime pas l'élément. Par exemple, Clear-Item peut supprimer la valeur d'une variable, mais la variable n'est pas supprimée. La valeur qui représentait un élément effacé est définie par chaque fournisseur Windows PowerShell. Clear-Item est semblable à Clear-Content, à ceci près qu'elle est utilisée avec des alias et des variables au lieu de fichiers.

Paramètres

-Credential <PSCredential>

Spécifie un compte d'utilisateur qui a l'autorisation d'exécuter cette action. La valeur par défaut est l'utilisateur actuel.

Tapez un nom d'utilisateur, tel que « User01 » ou « Domain01\User01 », ou entrez un objet PSCredential, tel que celui généré par l'applet de commande Get-Credential. Si vous tapez un nom d'utilisateur, vous êtes invité à entrer un mot de passe.

Ce paramètre n'est pas pris en charge par les fournisseurs installés avec Windows PowerShell.

Obligatoire ?	false
Position ?	named
Valeur par défaut
Accepter l'entrée de pipeline ?	true (ByPropertyName)
Accepter les caractères génériques ?	false

-Exclude <string[]>

Omet les éléments spécifiés. 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.

Obligatoire ?	false
Position ?	named
Valeur par défaut
Accepter l'entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-Filter <string>

Spécifie un filtre dans le format ou le langage du fournisseur. La valeur de ce paramètre qualifie le paramètre Path. La syntaxe du filtre, notamment l'utilisation de caractères génériques, dépend du fournisseur. Les filtres sont plus efficaces que les autres paramètres, car le fournisseur les applique lors de la récupération des objets, plutôt que de laisser le soin à Windows PowerShell de filtrer les objets une fois qu'ils ont été récupéré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 des éléments qui ne peuvent pas être changé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. Même en utilisant le paramètre Force, l'applet de commande ne peut pas remplacer les restrictions de sécurité.

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 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.

Obligatoire ?	false
Position ?	named
Valeur par défaut
Accepter l'entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-LiteralPath <string[]>

Spécifie le chemin d'accès aux éléments qui sont effacés. Contrairement à Path, la valeur de LiteralPath est utilisée exactement telle que vous la tapez. 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 à Windows PowerShell qu'aucun caractère ne doit être interprété en tant que séquence d'échappement.

Obligatoire ?	true
Position ?	1
Valeur par défaut
Accepter l'entrée de pipeline ?	true (ByPropertyName)
Accepter les caractères génériques ?	false

-Path <string[]>

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 nom de paramètre (« Path ») est facultatif.

Obligatoire ?	true
Position ?	1
Valeur par défaut
Accepter l'entrée de pipeline ?	true (ByValue, ByPropertyName)
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

-UseTransaction

Inclut la commande dans la transaction active. Ce paramètre est valide uniquement lorsqu'une transaction est en cours. Pour plus d'informations, consultez about_Transactions.

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	System.String Vous pouvez diriger une chaîne de chemin d'accès vers Clear-Item.
Sorties	None Cette applet de commande ne retourne pas d'objets.

Remarques

L'applet de commande Clear-Item est prise en charge par quelques fournisseurs Windows PowerShell uniquement, notamment les fournisseurs Alias, Environment, Function, Variable et Registry. Ainsi, vous pouvez utiliser Clear-Item pour supprimer le contenu d'éléments dans les espaces de noms du fournisseur.

Vous ne pouvez pas utiliser Clear-Item pour supprimer le contenu d'un fichier, car cette applet de commande n'est pas prise en charge par le fournisseur FileSystem de Windows PowerShell. Pour effacer des fichiers, utilisez Clear-Content.

Vous pouvez également faire référence à Clear-Item par son alias intégré, « cli ». Pour plus d'informations, tapez « get-help about_Aliases ».

L'applet de commande Clear-Item est conçue pour utiliser les données exposées par n'importe quel fournisseur. Pour répertorier les fournisseurs disponibles dans votre session, tapez « Get-PsProvider ». Pour plus d'informations, consultez about_Providers.

Exemple 1

C:\PS>clear-item Variable:TestVar1

Description
-----------
Cette commande supprime la valeur de la variable Testvar1. La variable n'est pas supprimée et demeure valide, mais sa valeur est null. 
  
Le nom de la variable est précédé de « Variable: » pour indiquer le fournisseur Variable de Windows PowerShell. Vous pouvez obtenir le même résultat en basculant vers l'espace de noms du fournisseur Variable de Windows PowerShell, puis en exécutant la commande Clear-Item.

    PS C:> Set-location Variable:
    PS Variable:\> clear-item Testvar1

Exemple 2

C:\PS>clear-item Alias:log* -include *1* -exclude *3* -whatif

What if: Performing operation "Clear Item" on Target "Item: log1".

Description
-----------
Cette commande demande à Windows PowerShell le résultat qui serait obtenu en cas d'exécution de la commande « clear-item alias:log* -include *1* -exclude *3 ». En réponse, Windows PowerShell indiquerait la suppression de la valeur de l'alias log1. 

Cette commande n'aurait aucun effet sur les alias log, log2 ou log13. Comme le fournisseur Alias n'autorise pas les alias sans valeur, lorsque vous effacez un alias, vous supprimez également cet alias.

Exemple 3

C:\PS>clear-item registry::HKLM\Software\MyCompany\MyKey -confirm

Description
-----------
Cette commande supprime toutes les entrées de Registre dans la sous-clé MyKey, mais uniquement après confirmation de votre part. Elle ne supprime pas la sous-clé MyKey et n'affecte pas les autres clés ou entrées du 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 particulières, utilisez Remove-ItemProperty. Pour supprimer la valeur d'une entrée de Registre, utilisez Clear-ItemProperty.

Voir aussi

Concepts

about_Providers
Copy-Item
Get-Item
Invoke-Item
Move-Item
Set-Item
New-Item
Remove-Item
Rename-Item