Clear-Item
アイテムの内容をクリアしますが、アイテムは削除しません。
構文
Clear-Item
[-Path] <String[]>
[-Force]
[-Filter <String>]
[-Include <String[]>]
[-Exclude <String[]>]
[-Credential <PSCredential>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]Clear-Item
-LiteralPath <String[]>
[-Force]
[-Filter <String>]
[-Include <String[]>]
[-Exclude <String[]>]
[-Credential <PSCredential>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]説明
コマンドレットは Clear-Item 項目の内容をクリアしますが、アイテムは削除されません。
たとえば、コマンドレットは Clear-Item 変数の値を削除できますが、変数は削除されません。 クリアされた項目を表すために使用される値は、各 PowerShell プロバイダーによって定義されます。
このコマンドレットは似ています Clear-Contentが、ファイルの代わりにエイリアスと変数で動作します。
例
例 1: 変数の値をクリアする
このコマンドは、という名前 TestVar1の変数の値をクリアします。
変数は保持され、有効ですが、その値は $null.
変数名には、PowerShell 変数プロバイダーを示すプレフィックスが付 Variable: きます。
別のコマンドは、同じ結果を得るために、PowerShell Variable: ドライブに切り替えてからコマンドを Clear-Item 実行できることを示しています。
Clear-Item Variable:TestVar1
Set-Location Variable:
PS Variable:\> Clear-Item TestVar1例 2: すべてのレジストリ エントリをクリアする
このコマンドは、"MyKey" サブキー内のすべてのレジストリ エントリをクリアしますが、意図の確認を求められた後にのみ消去されます。 "MyKey" サブキーを削除したり、他のレジストリ キーやエントリに影響を与えたりすることはありません。 Include パラメーターと Exclude パラメーターを使用してレジストリ キーを指定できますが、これらのパラメーターでレジストリ エントリを指定することはできません。
- 特定のレジストリ エントリを削除するには、
Remove-ItemPropertyコマンドレットを使用します。 - レジストリ エントリの値を削除するには、
Clear-ItemProperty cmdlet.
Clear-Item HKLM:\Software\MyCompany\MyKey -Confirmパラメーター
-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」を参照してください。 Force パラメーターが使用されている場合でも、コマンドレットはセキュリティ制限をオーバーライドできません。
| 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 |
-Path
削除する項目のパスを指定します。 ワイルドカード文字を使用できます。 このパラメーターは必須ですが、パラメーター名 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
このコマンドレットは出力を生成しません。
メモ
- この
Clear-Itemコマンドレットは、 エイリアス、 環境、 関数、 レジストリ、 変数 プロバイダーなど、複数の PowerShell プロバイダーでのみサポートされています。 そのため、プロバイダー名前空間内のアイテムの内容を削除するために使用Clear-Itemできます。 セッションで使用できるプロバイダーを一覧表示するには、「.」と入力しますGet-PsProvider。 詳細については、「about_Providers」を参照してください。 - PowerShell FileSystem プロバイダーではこのコマンドレットがサポートされていないため、ファイルの内容を削除するために使用
Clear-Itemすることはできません。 ファイルを消去するには、Clear-Content.