Remove-Variable
変数とその値を削除します。
構文
Remove-Variable [-Name] <string[]> [-Exclude <string[]>] [-Force] [-Include <string[]>] [-Scope <string>] [-Confirm] [-WhatIf] [<CommonParameters>]
説明
Remove-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 |
-Scope <string>
このエイリアスが有効なスコープを指定します。指定可能な値は、Global、Local、Script、または現在のスコープの相対的な数値 (0 ～スコープの数。ここで 0 は現在のスコープを表し、1 はその親を表す) です。既定値は Local です。詳細については、「about_Scopes」を参照してください。
必須 |
false |
位置 |
named |
既定値 |
|
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-Confirm
コマンドを実行する前に確認メッセージを表示します。
必須 |
false |
位置 |
named |
既定値 |
|
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-WhatIf
実際にコマンドを実行せずに、コマンドを実行すると何が起きるかを出力します。
必須 |
false |
位置 |
named |
既定値 |
|
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: -Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、および -OutVariable。詳細については、次を参照してください: about_Commonparameters.
入力と出力
入力値の型は、コマンドレットへのパイプが可能なオブジェクトの型です。戻り値の型は、コマンドレットによって返されるオブジェクトの型です。
入力 |
System.Management.Automation.PSVariable パイプを使用して、変数オブジェクトを Remove-Variable に渡すことができます。 |
出力 |
なし このコマンドレットによる戻り値はありません。 |
注
変更は、セッションなど現在のスコープにのみ影響します。すべてのセッションから変数を削除するには、Windows PowerShell プロファイルに Remove-Variable コマンドを追加します。
RemoveVariable は、その組み込みエイリアスである "rv" で参照することもできます。詳細については、「about_Aliases」を参照してください。
例 1
C:\PS>remove-variable Smp
説明
-----------
このコマンドは $Smp 変数を削除します。
関連項目
概念
Set-Variable
Get-Variable
Clear-Variable
New-Variable
about_Profiles