Clear-ItemProperty

Clear-ItemProperty [-LiteralPath] <string[]> [-Name] <string> [-Credential <PSCredential>] [-Exclude <string[]>] [-Filter <string>] [-Force] [-Include <string[]>] [-PassThru] [-確認] [-WhatIf] [-UseTransaction] [<CommonParameters>]

Clear-ItemProperty [-Path] <string[]> [-Name] <string> [-Credential <PSCredential>] [-Exclude <string[]>] [-Filter <string>] [-Force] [-Include <string[]>] [-PassThru] [-確認] [-WhatIf] [-UseTransaction] [<CommonParameters>]

Clear-ItemProperty コマンドレットはプロパティの値を削除します。プロパティ自体は削除しません。このコマンドレットを使用して、レジストリ値からデータを削除できます。

-Credential <PSCredential>

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

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

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

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

-Exclude <string[]>

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

必須	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[]>

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

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

-Name <string>

レジストリ値の名前など、削除するプロパティの名前を指定します。ワイルドカードは使用できません。

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

-PassThru

クリアされた項目のプロパティを表すオブジェクトを返します。既定では、このコマンドレットによる出力はありません。

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

-Path <string[]>

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

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

-確認

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

必須	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

パイプを使用してパス文字列を Clear-ItemProperty に渡すことができます。

出力

なし、または System.Management.Automation.PSCustomObject

PassThru パラメーターを使用する場合は、Clear-ItemProperty によって、クリアされた項目のプロパティを表す PSCustomObject オブジェクトが生成されます。それ以外の場合、このコマンドレットによる出力はありません。

Clear-ItemProperty を使用すると、レジストリ値自体は削除せずに、レジストリ値のデータを削除することができます。値のデータ型が Binary または DWORD の場合、データをクリアすると値にゼロが設定されます。それ以外の型の場合は、値は空になります。

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

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

C:\PS>clear-itemproperty -path HKLM:\Software\MyCompany\MyApp -name Options

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

コマンドはファイル システム ドライブ (C:) から実行されているため、HKLM: ドライブと Software\MyCompany\MyApp サブキーへの完全修飾パスを使用しています。また、Name パラメーターを使用して Options の値を指定しています。