Remove-ItemProperty
項目からプロパティとその値を削除します。
構文
Remove-ItemProperty
[-Path] <String[]>
[-Name] <String[]>
[-Force]
[-Filter <String>]
[-Include <String[]>]
[-Exclude <String[]>]
[-Credential <PSCredential>]
[-WhatIf]
[-Confirm]
[-UseTransaction]
[<CommonParameters>]
Remove-ItemProperty
-LiteralPath <String[]>
[-Name] <String[]>
[-Force]
[-Filter <String>]
[-Include <String[]>]
[-Exclude <String[]>]
[-Credential <PSCredential>]
[-WhatIf]
[-Confirm]
[-UseTransaction]
[<CommonParameters>]
説明
Remove-ItemProperty
コマンドレットは、プロパティとその値を項目から削除します。
これを使用して、レジストリ値とその中に格納されているデータを削除することができます。
例
例 1: レジストリ値を削除する
このコマンドは、"smpProperty" レジストリ値とそのデータを、"HKEY_LOCAL_MACHINE\Software" レジストリ キーの "SmpApplication" サブキーから削除します。
コマンドはファイル システム ドライブ (PS C:\>
) から発行されるため、"SmpApplication" サブキーの完全修飾パス (ドライブ、 HKLM:
、ソフトウェア キーなど) が含まれます。
Name パラメーターを使用して、削除されるレジストリ値を識別します。
Remove-ItemProperty -Path "HKLM:\Software\SmpApplication" -Name "SmpProperty"
例 2: HKCU の場所からレジストリ値を削除する
これらのコマンドは、"HKEY_CURRENT_USER\Software\MyCompany" の "MyApp" サブキーから "Options" レジストリ値とそのデータを削除します。
最初のコマンドでは、 Set-Location
コマンドレットを使用して、現在の場所を HKEY_CURRENT_USER ドライブ (HKCU:
) と "Software\MyCompany\MyApp" サブキーに変更します。
2 番目のコマンドでは、 Remove-ItemProperty
を使用して、"MyApp" サブキーから "Options" レジストリ値とそのデータを削除します。
Pathが必要であるため、コマンドはドット ('.') を使用して現在の場所を示します。
Name を使用して、削除するレジストリ値を指定します。
Confirm パラメーターを使用して、値を削除する前にユーザー プロンプトを要求します。
PS C:\> Set-Location HKCU:\Software\MyCompany\MyApp
PS HKCU:\Software\MyCompany\MyApp> Remove-ItemProperty -Path . -Name "Options" -Confirm
例 3: パイプラインを使用してレジストリ値を削除する
このコマンドは、"NoOfEmployees" レジストリ値とそのデータを "HKLM\Software\MyCompany" レジストリ キーから削除します。
このコマンドでは、 Get-Item
コマンドレットを使用して、レジストリ キーを表す項目を取得します。
パイプライン演算子 (|
) を使用して、オブジェクトを Remove-ItemProperty
に送信します。
次に、Remove-ItemProperty
の Name パラメーターを使用して、レジストリ値の名前を指定します。
Get-Item -Path HKLM:\Software\MyCompany | Remove-ItemProperty -Name NoOfEmployees
パラメーター
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
型: | SwitchParameter |
Aliases: | cf |
配置: | Named |
規定値: | False |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Credential
Note
このパラメーターは、PowerShell でインストールされているプロバイダーではサポートされていません。 別のユーザーを偽装したり、このコマンドレットの実行時に資格情報を昇格したりするには、 Invoke-Command を使用します。
型: | PSCredential |
配置: | Named |
規定値: | Current user |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Exclude
このコマンドレットが省略する項目を指定します。 このパラメーターの値は、 Path パラメーターを修飾します。 「*.txt」などのパス要素またはパターンを入力します。 ワイルドカード文字を使用できます。
型: | String[] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | True |
-Filter
プロバイダーの形式または言語でフィルターを指定します。 このパラメーターの値は、 Path パラメーターを修飾します。
ワイルドカード文字の使用を含むフィルターの構文は、プロバイダーによって異なります。 フィルターは、取得後に PowerShell でオブジェクトをフィルター処理するのではなく、コマンドレットがオブジェクトを取得するときにプロバイダーによって適用されるため、他のパラメーターよりも効率的です。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | True |
-Force
ユーザーがアクセスできないオブジェクトのプロパティを強制的に削除します。 実装はプロバイダーごとに異なります。 詳細については、「 about_Providers」を参照してください。
型: | SwitchParameter |
配置: | Named |
規定値: | False |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Include
文字列配列として、このコマンドレットが操作に含める項目を指定します。 このパラメーターの値は、 Path パラメーターを修飾します。 「*.txt」などのパス要素またはパターンを入力します。 ワイルドカード文字を使用できます。
型: | String[] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | True |
-LiteralPath
プロパティの現在の場所のパスを指定します。 Path パラメーターとは異なり、LiteralPath の値は、型指定されたとおりに使用されます。 ワイルドカードとして解釈される文字はありません。 パスにエスケープ文字が含まれている場合は、単一引用符で囲みます。 単一引用符は、エスケープ シーケンスとして文字を解釈しないように PowerShell に指示します。
型: | String[] |
Aliases: | PSPath |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Name
削除するプロパティの名前を指定します。 ワイルドカード文字を使用できます。
型: | String[] |
Aliases: | PSProperty |
配置: | 1 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | True |
-Path
プロパティを削除するアイテムのパスを指定します。 ワイルドカード文字を使用できます。
型: | String[] |
配置: | 0 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | True |
-UseTransaction
アクティブなトランザクションのコマンドが含まれます。 このパラメーターは、トランザクションが進行中の場合のみ有効です。 詳細については、「 about_Transactions」を参照してください。
型: | SwitchParameter |
Aliases: | usetx |
配置: | Named |
規定値: | False |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
型: | SwitchParameter |
Aliases: | wi |
配置: | Named |
規定値: | False |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
入力
リテラル パスではなくパスを含む文字列をこのコマンドレットにパイプできます。
出力
None
このコマンドレットは、出力を返しません。
メモ
Windows PowerShell には、 Remove-ItemProperty
の次のエイリアスが含まれています。
rp
PowerShell レジストリ プロバイダーでは、レジストリ値はレジストリ キーまたはサブキーのプロパティと見なされます。 ItemProperty コマンドレットを使用して、これらの値を管理できます。
Remove-ItemProperty
は、任意のプロバイダーによって公開されるデータを操作するように設計されています。 セッションで使用可能なプロバイダーを一覧表示するには、「 Get-PSProvider
」と入力します。 詳細については、「 about_Providers」を参照してください。
関連リンク
PowerShell