Remove-Variable
変数とその値を削除します。
構文
Default (既定)
Remove-Variable
[-Name] <String[]>
[-Include <String[]>]
[-Exclude <String[]>]
[-Force]
[-Scope <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
Remove-Variable コマンドレットは、変数とその値が定義されているスコープ (現在のセッションなど) から削除します。 このコマンドレットを使用して、定数として設定されている変数や、システムが所有する変数を削除することはできません。
例
例 1: 変数を削除する
PS C:\> Remove-Variable Smp
このコマンドは、$Smp変数を削除します。
パラメーター
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | cf |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Exclude
このコマンドレットが操作から除外する項目の配列を指定します。 このパラメーターの値は、Name パラメーターを修飾します。 "s*" などの名前要素またはパターンを入力します。 ワイルドカードを使用できます。
パラメーターのプロパティ
| 型: | String[] |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Force
読み取り専用の場合でも、コマンドレットによって変数が削除されることを示します。 Force パラメーターを使用しても、コマンドレットは定数を削除できません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Include
このコマンドレットが操作で削除する項目の配列を指定します。 このパラメーターの値は、Name パラメーターを修飾します。 名前要素またはパターン (s* など) を入力します。 ワイルドカードを使用できます。
パラメーターのプロパティ
| 型: | String[] |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Name
削除する変数の名前を指定します。 パラメーター名 (Name) は省略可能です。
パラメーターのプロパティ
| 型: | String[] |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-Scope
指定したスコープ内の変数のみを取得します。 このパラメーターに使用できる値は次のとおりです。
- グローバル
- ローカル
- スクリプト
- 現在のスコープに対する相対的な数値（スコープ数は0から始まり、0は現在のスコープ、1はその親スコープを表します）
既定値は Local です。 詳細については、「about_Scopes」を参照してください。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-WhatIf
コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ウィスコンシン |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
入力
PSVariable
変数オブジェクトを Remove-Variable にパイプ処理できます。
出力
None
このコマンドレットによる戻り値はありません。
メモ
変更は、セッションなどの現在のスコープにのみ影響します。 すべてのセッションから変数を削除するには、Windows PowerShell プロファイルに Remove-Variable コマンドを追加します。
Remove-Variable は、組み込みエイリアス rv で参照することもできます。 詳細については、「about_Aliases」を参照してください。