次の方法で共有

Clear-Item

  • リファレンス
モジュール:
Microsoft.PowerShell.Management

アイテムの内容をクリアしますが、アイテムは削除しません。

構文

Clear-Item
     [-Path] <String[]>
     [-Force]
     [-Filter <String>]
     [-Include <String[]>]
     [-Exclude <String[]>]
     [-Credential <PSCredential>]
     [-WhatIf]
     [-Confirm]
     [-UseTransaction]
     [<CommonParameters>]
Clear-Item
     -LiteralPath <String[]>
     [-Force]
     [-Filter <String>]
     [-Include <String[]>]
     [-Exclude <String[]>]
     [-Credential <PSCredential>]
     [-WhatIf]
     [-Confirm]
     [-UseTransaction]
     [<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

コマンドレットの実行前に確認を求めるメッセージが表示されます。

型:SwitchParameter
Aliases:cf
配置:Named
規定値:False
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Credential

Note

このパラメーターは、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

読み取り専用エイリアスなど、変更できない項目をコマンドレットがクリアすることを示します。 このコマンドレットでは、定数はクリアできません。 実装はプロバイダーごとに異なります。 詳細については、「 about_Providers」を参照してください。 コマンドレットは、 Force パラメーターが使用されている場合でも、セキュリティ制限をオーバーライドできません。

型: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
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-Path

削除する項目のパスを指定します。 ワイルドカード文字を使用できます。 このパラメーターは必須ですが、パラメーター名 Path は省略可能です。

型:String[]
配置:0
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:True

-UseTransaction

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

型:SwitchParameter
Aliases:usetx
配置:Named
規定値:False
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

型:SwitchParameter
Aliases:wi
配置:Named
規定値:False
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

入力

String

パス文字列をこのコマンドレットにパイプできます。

出力

None

このコマンドレットは、出力を返しません。

メモ

Windows PowerShell には、 Clear-Itemの次のエイリアスが含まれています。

  • cli

  • Clear-Item コマンドレットは、Alias、Environment、Function、Registry、Variable プロバイダーなど、いくつかの PowerShell プロバイダーでのみサポートされています。 そのため、 Clear-Item を使用して、プロバイダー名前空間内の項目の内容を削除できます。 セッションで使用可能なプロバイダーを一覧表示するには、「 Get-PsProvider」と入力します。 詳細については、「 about_Providers」を参照してください。

  • PowerShell FileSystem プロバイダーではこのコマンドレットがサポートされていないため、 Clear-Item を使用してファイルの内容を削除することはできません。 ファイルをクリアするには、 Clear-Contentを使用します。