Remove-Variable

  • 参考
模块:
Microsoft.PowerShell.Utility

删除变量及其值。

语法

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

说明

Remove-Variable cmdlet 将从定义了变量的作用域（例如，当前会话）中删除变量及其值。 你不能使用此 cmdlet 删除设置为常量或由系统所拥有的变量。

示例

示例 1：移除变量

Remove-Variable Smp

此命令删除 $Smp 变量。

参数

-Confirm

提示你在运行 cmdlet 之前进行确认。

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

-Exclude

指定此 cmdlet 在操作中将忽略的项的数组。 此参数值使 Name 参数有效。 请输入名称元素或模式，例如“s*”。 允许使用通配符。

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

-Force

指示 cmdlet 移除某个变量，即使该变量是只读的。 即使使用 Force 参数，cmdlet 也无法移除常量。

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

-Include

指定此 cmdlet 将在操作中删除的项数组。 此参数值使 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

显示运行该 cmdlet 时会发生什么情况。 cmdlet 未运行。

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

输入

PSVariable

可以通过管道将变量对象传递给此 cmdlet。

输出

None

此 cmdlet 不返回任何输出。

备注

PowerShell 包含 Remove-Variable 的以下别名：

  • 所有平台：

    • rv

  • 更改仅影响当前作用域，例如会话。 若要从所有会话中删除变量，请将 Remove-Variable 命令添加到 PowerShell 配置文件。