Clear-Variable

Clear-Variable [-Name] <string[]> [-Exclude <string[]>] [-Force] [-Include <string[]>] [-PassThru] [-Scope <string>] [-確認] [-WhatIf] [<CommonParameters>]

Clear-Variable コマンドレットは変数に保存されているデータを削除しますが、変数は削除しません。その結果、変数の値は NULL (空) になります。変数にデータ型またはオブジェクト型が指定されている場合、Clear-Variable は変数に保存されているオブジェクトの型を保持します。

-Exclude <string[]>

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

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

-Force

変数が読み取り専用であっても、コマンドレットにより変数をクリアできるようにします。Force パラメーターを使用しても、コマンドレットで定数をクリアすることはできません。

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

-Include <string[]>

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

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

-Name <string[]>

クリアする変数の名前を指定します。ワイルドカードを使用できます。このパラメーターは必須ですが、パラメーター名 ("Name") は省略可能です。

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

-PassThru

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

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

-Scope <string>

このエイリアスが有効なスコープを指定します。指定可能な値は、Global、Local、Script、または現在のスコープの相対的な数値 (0 ～スコープの数。ここで 0 は現在のスコープを表し、1 はその親を表す) です。既定値は Local です。詳細については、「about_Scopes」を参照してください。

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

-確認

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

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

-WhatIf

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

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

<CommonParameters>

このコマンドレットは、次の共通パラメーターをサポートします: -Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、および -OutVariable。Ô”¼š¤Ë¤Ä¤¤¤Æ¤Ï¡¢次を参照してください: about_Commonparameters.

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

入力

なし

パイプを使用してオブジェクトを Clear-Variable に渡すことはできません。

出力

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

PassThru パラメーターを使用すると、Clear-Variable はクリアされた変数を表す System.Management.Automation.PSVariable オブジェクトを生成します。それ以外の場合、このコマンドレットによる出力はありません。

変数およびその値を削除するには、Remove-Variable または Remove-Item を使用します。

Clear-Variable は、-Force パラメーターが使用されている場合でも、定数として設定されている値、またはシステムによって所有されている変数の値を削除することはありません。

クリアする変数が存在しない場合、コマンドレットの効果はありません。null 値を持つ変数は作成されません。

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

C:\PS>clear-variable my* -global

説明
-----------
このコマンドは、"my" という文字で始まるグローバル変数の値を削除します。

C:\PS>$a=3

C:\PS>&{ clear-variable a }

C:\PS>$a
3

説明
-----------
これらのコマンドは、子スコープ内の変数をクリアしても親スコープ内の値はクリアされないことを示します。最初のコマンドは、変数 $a の値を "3" に設定します。2 番目のコマンドは、呼び出し演算子 (&) を使用し、新しいスコープ内で Clear-Variable コマンドを実行します。変数は子スコープ (今回は存在しません) でクリアされますが、ローカル スコープではクリアされません。3 番目のコマンドは、$a の値を取得し、"3" という値に変化がないことを示しています。

C:\PS>clear-variable -name processes

説明
-----------
このコマンドは、$processes 変数の値を削除します。$processes 変数は引き続き存在しますが、値は null になります。