Supprime la valeur d'une propriété mais ne supprime pas la propriété.

Syntaxe

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

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

Description

L'applet de commande Clear-ItemProperty supprime la valeur d'une propriété mais ne supprime pas la propriété. Vous pouvez utiliser cette applet de commande pour supprimer les données d'une valeur du Registre.

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 » ou « s* ». 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 de supprimer les propriétés d'éléments qui, sinon, ne sont pas accessibles par l'utilisateur. L'implémentation est différente d'un fournisseur à l'autre. Pour plus d'informations, consultez about_Providers.

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 à la propriété à effacer. 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

-Name <string>

Spécifie le nom de la propriété à effacer, tel que le nom d'une valeur de Registre. Les caractères génériques ne sont pas autorisés.

Obligatoire ?

true

Position ?

2

Valeur par défaut

Accepter l'entrée de pipeline ?

true (ByPropertyName)

Accepter les caractères génériques ?

false

-PassThru

Retourne un objet représentant la propriété de l'élément effacée. Par défaut, cette applet de commande ne génère aucune sortie.

Obligatoire ?

false

Position ?

named

Valeur par défaut

Accepter l'entrée de pipeline ?

false

Accepter les caractères génériques ?

false

-Path <string[]>

Spécifie le chemin d'accès à la propriété à effacer. Les caractères génériques sont autorisés.

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

Sorties

Aucun ou System.Management.Automation.PSCustomObject

Lorsque vous utilisez le paramètre PassThru, Clear-ItemProperty génère un objet PSCustomObject qui représente la propriété d'élément effacée. Sinon, cette applet de commande ne génère aucune sortie.

Remarques

Vous pouvez utiliser Clear-ItemProperty pour supprimer les données de valeurs du Registre sans supprimer les valeurs. Si les données de la valeur sont de type Binaire ou DWORD, l'effacement des données rend la valeur égale à zéro. Sinon, la valeur est vide.

Vous pouvez également faire référence à Clear-ItemProperty par son alias intégré, « clp ». Pour plus d'informations, consultez about_Aliases.

L'applet de commande Clear-ItemProperty 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-itemproperty -path HKLM:\Software\MyCompany\MyApp -name Options

Description
-----------
Cette commande supprime les données de la valeur de Registre Options dans la sous-clé MyApp de HKEY_LOCAL_MACHINE\Software\MyCompany.

Dans la mesure où la commande est émise à partir d'un lecteur de système de fichiers (C:), elle utilise le chemin d'accès complet au lecteur HKLM: et la sous-clé Software\MyCompany\MyApp. Elle utilise le paramètre Name pour spécifier la valeur Options.






Voir aussi




Table des matières