Remove-Variable
変数とその値を削除します。
構文
Remove-Variable
[-Name] <String[]>
[-Include <String[]>]
[-Exclude <String[]>]
[-Force]
[-Scope <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
Remove-Variable
コマンドレットは、現在のセッションなど、定義されているスコープから変数とその値を削除します。 このコマンドレットでは、定数として設定されている変数、およびシステムに所有されている変数は削除できません。
例
例 1: 変数を削除する
Remove-Variable Smp
このコマンドは、 $Smp
変数を削除します。
パラメーター
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
型: | SwitchParameter |
Aliases: | cf |
配置: | Named |
規定値: | False |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Exclude
このコマンドレットが操作から除外する項目の配列を指定します。 このパラメーターの値は、 Name パラメーターを修飾します。 「s*」などの名前要素またはパターンを入力します。 ワイルドカードを使用できます。
型: | String[] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | True |
-Force
読み取り専用の場合でも、コマンドレットによって変数が削除されることを示します。 Force パラメーターを使用しても、コマンドレットは定数を削除できません。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Include
このコマンドレットが操作で削除する項目の配列を指定します。 このパラメーターの値は、 Name パラメーターを修飾します。 名前要素またはパターン (s* など) を入力します。 ワイルドカードを使用できます。
型: | String[] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | True |
-Name
削除する変数の名前を指定します。 パラメーター名 (Name) は省略可能です。 ワイルドカードを使用できます
型: | String[] |
配置: | 0 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | True |
-Scope
指定したスコープの変数のみを取得します。 このパラメーターの有効値は、次のとおりです。
- グローバル
- ローカル
- スクリプト
- 現在のスコープに対する相対的な数値 (0 からスコープの数、0 が現在のスコープ、1 がその親)
既定値は Local です。 詳細については、「 about_Scopes」を参照してください。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
型: | SwitchParameter |
Aliases: | wi |
配置: | Named |
規定値: | False |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
入力
変数オブジェクトをこのコマンドレットにパイプできます。
出力
None
このコマンドレットは、出力を返しません。
メモ
PowerShell には、 Remove-Variable
の次のエイリアスが含まれています。
すべてのプラットフォーム:
rv
変更は、セッションなど現在のスコープにのみ影響します。 すべてのセッションから変数を削除するには、powerShell プロファイルに
Remove-Variable
コマンドを追加します。
関連リンク
PowerShell