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