Remove-ItemProperty

[アーティクル]
10/30/2009

項目からプロパティとその値を削除します。

構文

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

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

説明

Remove-ItemProperty コマンドレットは、項目からプロパティとその値を削除します。これを使用して、レジストリ値とその中に格納されているデータを削除することができます。

パラメーター

-Credential <PSCredential>

この処理を実行するアクセス許可を持つユーザーアカウントを指定します。既定値は現在のユーザーです。

"User01" や "Domain01\User01" のようなユーザー名を入力するか、Get-Credential コマンドレットで生成されるような PSCredential オブジェクトを入力します。ユーザー名を入力すると、パスワードの入力を促すメッセージが表示されます。

このパラメーターは、Windows PowerShell でインストールされるプロバイダーではサポートされていません。

必須	false
位置	named
既定値
パイプライン入力を許可する	true (ByPropertyName)
ワイルドカード文字を許可する	false

-Exclude <string[]>

指定した項目を除外します。このパラメーターの値は、Path パラメーターを修飾します。"*.txt" などのパス要素またはパターンを入力します。ワイルドカードを使用できます。

必須	false
位置	named
既定値
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-Filter <string>

プロバイダーの形式や言語でフィルターを指定します。このパラメーターの値は、Path パラメーターを修飾します。ワイルドカードを使用できるかどうかなど、フィルターの構文はプロバイダーによって異なります。フィルターは他のパラメーターよりも効率が良い方法です。これは、オブジェクトを取得した後に Windows PowerShell がオブジェクトをフィルターするのではなく、オブジェクトを取得する際にプロバイダーがフィルターを適用するためです。

必須	false
位置	named
既定値
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-Force

設定しないとユーザーがアクセスできないオブジェクトのプロパティをコマンドレットで削除できるようにします。実装はプロバイダーごとに異なります。詳細については、「about_Providers」を参照してください。

必須	false
位置	named
既定値
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-Include <string[]>

指定した項目だけを削除します。このパラメーターの値は、Path パラメーターを修飾します。"*.txt" などのパス要素またはパターンを入力します。ワイルドカードを使用できます。

必須	false
位置	named
既定値
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-LiteralPath <string[]>

項目プロパティへのパスを指定します。LiteralPath の値は、入力した内容のまま使用されます。ワイルドカードとして解釈される文字はありません。パスにエスケープ文字が含まれている場合は、単一引用符で囲みます。単一引用符で囲んだ文字はエスケープシーケンスとして解釈されません。

必須	true
位置	1
既定値
パイプライン入力を許可する	true (ByPropertyName)
ワイルドカード文字を許可する	false

-Name <string[]>

取得するプロパティの名前を指定します。

必須	true
位置	2
既定値
パイプライン入力を許可する	true (ByPropertyName)
ワイルドカード文字を許可する	false

-Path <string[]>

プロパティを削除する項目のパスを指定します。ワイルドカードを使用できます。

必須	true
位置	1
既定値
パイプライン入力を許可する	true (ByValue, ByPropertyName)
ワイルドカード文字を許可する	false

-Confirm

コマンドを実行する前に確認メッセージを表示します。

必須	false
位置	named
既定値
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-WhatIf

実際にコマンドを実行せずに、コマンドを実行すると何が起きるかを出力します。

必須	false
位置	named
既定値
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-UseTransaction

コマンドを有効なトランザクションに含めます。このパラメーターは、トランザクションの進行中のみ有効です。詳細については、「about_Transactions」を参照してください。

必須	false
位置	named
既定値
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

<CommonParameters>

このコマンドレットは、次の共通パラメーターをサポートします: -Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、および -OutVariable。詳細については、次を参照してください: about_Commonparameters.

入力と出力

入力値の型は、コマンドレットへのパイプが可能なオブジェクトの型です。戻り値の型は、コマンドレットによって返されるオブジェクトの型です。

入力

System.String

パイプを使用してパス (リテラルパスではない) を含む文字列を Remove-ItemProperty に渡すことができます。

出力

なし

このコマンドレットによる戻り値はありません。

注

Remove-ItemProperty は、その組み込みエイリアスである "rp" で参照することもできます。詳細については、「about_Alias」を参照してください。

Windows PowerShell Registry プロバイダーでは、レジストリ値はレジストリキーまたはサブキーのプロパティと見なされます。ItemProperty コマンドレットを使用して、これらの値を管理できます。

Remove-ItemProperty コマンドレットは、プロバイダーによって公開されているデータを使用するように設計されています。セッションで使用可能なプロバイダーの一覧を表示するには、「Get-PSProvider」と入力します。詳細については、「about_Providers」を参照してください。

例 1

C:\PS>remove-itemproperty -path HKLM:\Software\SmpApplication -name SmpProperty

説明
-----------
このコマンドを実行すると、HKEY_LOCAL_MACHINE\Software レジストリ キーの SmpApplication サブキーから、レジストリ値 SmpProperty とそのデータが削除されます。

このコマンドはファイル システム ドライブ (C:\PS>) から実行しているので、ドライブ HKLM: と Software キーを含む、SmpApplication サブキーへの完全修飾パスを使用しています。

削除対象のレジストリ値は、Name パラメーターを使用して指定しています。

例 2

C:\PS>set-location HKCU:\Software\MyCompany\MyApp

PS HKCU:\Software\MyCompany\MyApp> remove-itemproperty -path . -Name Options -confirm

説明
-----------
これらのコマンドを実行すると、HKEY_CURRENT_USER\Software\MyCompany の MyApp サブキーから、レジストリ値 Options とそのデータが削除されます。

最初のコマンドでは、Set-Location コマンドレットを使用して現在の場所を HKEY_CURRENT_USER ドライブ (HKCU:) および Software\MyCompany\MyApp サブキーに変更しています。

2 番目のコマンドでは、Remove-Item コマンドレットを使用して、MyApp サブキーからレジストリ値 Options とそのデータを削除しています。Path パラメーターは必須であるため、ドット (.) を使用して現在の場所を示しています。また、Name パラメーターを使用して、削除対象のレジストリ値を指定しています。さらに、Confirm パラメーターを使用して、値を削除する前に確認メッセージを表示するよう指示しています。

例 3

C:\PS>get-item -path HKLM:\Software\MyCompany | remove-itemproperty -name NoOfEmployees

説明
-----------
このコマンドを実行すると、HKLM\Software\MyCompany レジストリ キーから、レジストリ値 NoOfEmployees とそのデータが削除されます。

このコマンドは、Get-Item コマンドレットを使用して、レジストリ キーを表す項目を取得します。このコマンドは、パイプライン演算子 (|) を使用して、オブジェクトを Remove-ItemProperty コマンドレットに送信します。その後、Remove-ItemProperty の Name パラメーターを使用して、レジストリ値の名前を指定します。

次の方法で共有