PowerShellコマンドレット虎の巻

Clear-ItemProperty

Clear-ItemPropertyは、アイテムプロパティの値のみをクリアするコマンドです。

エイリアスclp

解説

アイテムのプロパティ値をクリアします。
主にレジストリ値をクリアする際に使用されます。

構文

(構文)
Clear-ItemProperty [-Path] <string[]> [-Name] <string> [<CommonParameters>] Clear-ItemProperty [-Name] <string> [<CommonParameters>]
【主要パラメータ】
パラメータ説明
-Path パスプロパティをクリアするアイテムのパスを指定する
※必須パラメータ
-LiteralPath パス対象パスを指定する(ワイルドカード使用不可)
(例)-LiteralPath "D:\test"
-Name プロパティ名クリアするプロパティの名前を指定する
※必須パラメータ
-PassThruクリアされたプロパティのオブジェクトを出力する
-Force強制的に実行する
-Filterアイテムのプロパティをフィルタリングするための条件を指定する
(例)-Filter "Option*"
-Include 文字列指定した文字列を対象に含める
(ワイルドカード使用可)
(例)-Include *.log,*.tmp
 ⇒拡張子がlog、tmpのファイルを含める
-Exclude 文字列指定した文字列を対象から除外する
(ワイルドカード使用可)
(例)-Exclude Test*
 ⇒ファイルがTestで始まる物を除外する
-WhatIf実行はせずに実行結果の確認のみ行う
-Confirm実行前に確認メッセージの表示を行う
-UseTransactionトランザクションに参加する

共通的なパラメータは「共通パラメータ」をご覧ください。

サンプル

レジストリ値をクリアする

Clear-ItemProperty -Path "HKLM:\Software\MyCompany\MyApp" -Name "Options"

レジストリ値をクリアする(パイプラインで渡す方法)

Get-Item "HKLM:\Software\MyCompany\MyApp" | Clear-ItemProperty -Name "Options"

複数のレジストリ値をクリアする

Clear-ItemProperty -Path "HKLM:\Software\MyCompany\MyApp" -Name "Setting1", "Setting2", "Setting3"

クリアと同時にクリアされたアイテムプロパティを表すオブジェクトを出力する

Clear-ItemProperty -Path "HKLM:\Software\MyCompany\MyApp" -Name "Options" -PassThru

コマンドのヘルプを表示する

Get-Help Clear-ItemProperty

備考

  • Clear-ItemPropertyは、プロパティの値をクリアしますがプロパティ自体は削除しません。
  • 実行時にPowerShellを管理者として実行する必要がある場合があります。

関連項目