Clear-Variable

删除变量的值。

语法

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

说明

Clear-Variable cmdlet 删除存储在变量中的数据,但不删除该变量。 因此,该变量的值为 NULL(空)。 如果变量具有指定的数据或对象类型,则此 cmdlet 将保留存储在变量中的对象的类型。

示例

示例 1:删除以搜索字符串开头的全局变量的值

PS C:\> Clear-Variable my* -Scope Global

此命令删除名称以 my 开头的全局变量的值。

示例 2:清除子范围中的变量,但不清除父范围中的变量

PS C:\> $a=3
PS C:\> &{ Clear-Variable a }
PS C:\> $a
3

这些命令演示了清除子作用域中的变量并不会清除父作用域中的值。 第一个命令将变量的值$A设置为 3。 第二个命令使用调用运算符 (&) 在新作用域中运行 Clear-Variable 命令。 在子作用域中清除该变量(尽管它不存在),但不会在本地作用域中清除它。 获取$A值的第三个命令显示值 3 不受影响。

示例 3:删除指定变量的值

PS C:\> Clear-Variable -Name "Processes"

此命令删除名为 Processes 的变量的值。 cmdlet 完成操作后,名为 Processes 的变量仍然存在,但值为 null。

参数

-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

指定要清除的变量的名称。 允许使用通配符。 此参数为必需参数,但参数名(“名称”)为可选项。

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

-PassThru

返回一个代表你所处理的项目的对象。 默认情况下,此 cmdlet 将不产生任何输出。

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

-Scope

指定此别名的有效作用域。

此参数的可接受值为:

  • 全球
  • Local
  • 脚本

还可以使用相对于当前范围 (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

输入

None

不能通过管道将对象传递给此 cmdlet。

输出

None or System.Management.Automation.PSVariable

使用 PassThru 参数时,此 cmdlet 会生成一个表示清除变量的 System.Management.Automation.PSVariable 对象。 否则,此 cmdlet 将不生成任何输出。

备注

  • 若要删除变量及其值,请使用删除 Remove-Variable 或 Remove-Item。

    此 cmdlet 不会删除设置为常量或由系统拥有的变量的值,即使使用 Force 参数也是如此。

    如果你清除的变量不存在,则此 cmdlet 无效。 它不会创建具有 null 值的变量。

    还可以通过其内置别名 clv 引用 Clear-Variable 。 有关详细信息,请参阅 about_Aliases。