Remove-Variable

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

変数とその値を削除します。

構文

Remove-Variable
      [-Name] <String[]>
      [-Include <String[]>]
      [-Exclude <String[]>]
      [-Force]
      [-Scope <String>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

コマンドレットは Remove-Variable 、現在のセッションなど、定義されているスコープから変数とその値を削除します。 このコマンドレットでは、定数として設定されている変数、およびシステムに所有されている変数は削除できません。

例

例 1: 変数を削除する

Remove-Variable Smp

このコマンドは変数を $Smp 削除します。

パラメーター

-Confirm

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

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Exclude

このコマンドレットが操作から除外する項目の配列を指定します。 このパラメーターの値は、Name パラメーターを修飾します。 「s*」などの名前要素またはパターンを入力します。 ワイルドカードを使用できます。

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-Force

読み取り専用の場合でも、コマンドレットによって変数が削除されることを示します。 Force パラメーターを使用しても、コマンドレットは定数を削除できません。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Include

このコマンドレットが操作で削除する項目の配列を指定します。 このパラメーターの値は、Name パラメーターを修飾します。 名前要素またはパターン (s* など) を入力します。 ワイルドカードを使用できます。

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-Name

削除する変数の名前を指定します。 パラメーター名 (Name) は省略可能です。 ワイルドカードは許可されています

Type:String[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:True

-Scope

指定したスコープの変数のみを取得します。 このパラメーターの有効値は、次のとおりです。

  • グローバル
  • ローカル
  • スクリプト
  • 現在のスコープに対する相対的な数値 (0 からスコープの数、0 が現在のスコープ、1 がその親)

既定値は Local です。 詳細については、「about_Scopes」を参照してください。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

入力

PSVariable

変数オブジェクトをこのコマンドレットにパイプできます。

出力

None

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

メモ

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

  • すべてのプラットフォーム:

    • rv

  • 変更は、セッションなど現在のスコープにのみ影響します。 すべてのセッションから変数を削除するには、PowerShell プロファイルにコマンドを追加 Remove-Variable します。