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