Поделиться через

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

Запрашивает подтверждение перед запуском командлета.

Тип:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Exclude

Указывает массив элементов, которые этот командлет пропускает из операции. Значение этого параметра квалифифициирует параметр Name. Введите элемент имени или шаблон, например "s*". Разрешены подстановочные знаки.

Тип:String[]
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:True

-Force

Указывает, что командлет удаляет переменную, даже если она доступна только для чтения. Даже при использовании параметра Force командлет не может удалить константу.

Тип:SwitchParameter
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Include

Указывает массив элементов, которые этот командлет удаляет в операции. Значение этого параметра квалифифициирует параметр Name. Введите элемент имени или шаблон, например s*. Разрешены подстановочные знаки.

Тип:String[]
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:True

-Name

Указывает имя удаляемой переменной. Имя параметра (имя) является необязательным. Подстановочные знаки разрешены

Тип:String[]
Position:0
Default value:None
Обязательно:True
Принять входные данные конвейера:True
Принять подстановочные знаки:True

-Scope

Возвращает только переменные в указанной области. Допустимые значения для этого параметра:

  • Глобальный
  • Местный
  • Сценарий
  • Число относительно текущей области (от 0 до числа областей, где 0 является текущей областью, а 1 — родительским)

Локальный — это значение по умолчанию. Дополнительные сведения см. в about_Scopes.

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-WhatIf

Показывает, что произойдет, если командлет выполняется. Командлет не выполняется.

Тип:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

Входные данные

PSVariable

Объект переменной можно передать в этот командлет.

Выходные данные

None

Этот командлет не возвращает выходные данные.

Примечания

PowerShell включает следующие псевдонимы для Remove-Variable:

  • Все платформы:

    • rv

  • Изменения влияют только на текущую область, например сеанс. Чтобы удалить переменную из всех сеансов, добавьте команду Remove-Variable в профиль PowerShell.