Поиск по сайту:

Remove-Variable (Microsoft.PowerShell.Utility)

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

Псевдонимы:

cf

Позиция:

Именованный

Значение по умолчанию:

False

Необходимый:

False

Примите ввод конвейера:

False

Принимайте подстановочные знаки:

False

-Exclude

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

Тип :

String[]

Позиция:

Именованный

Значение по умолчанию:

None

Необходимый:

False

Примите ввод конвейера:

False

Принимайте подстановочные знаки:

True

-Force

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

Тип :

SwitchParameter

Позиция:

Именованный

Значение по умолчанию:

None

Необходимый:

False

Примите ввод конвейера:

False

Принимайте подстановочные знаки:

False

-Include

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

Тип :

String[]

Позиция:

Именованный

Значение по умолчанию:

None

Необходимый:

False

Примите ввод конвейера:

False

Принимайте подстановочные знаки:

True

-Name

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

Тип :

String[]

Позиция:

0

Значение по умолчанию:

None

Необходимый:

True

Примите ввод конвейера:

True

Принимайте подстановочные знаки:

True

-Scope

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

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

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

Тип :

String

Позиция:

Именованный

Значение по умолчанию:

None

Необходимый:

False

Примите ввод конвейера:

False

Принимайте подстановочные знаки:

False

-WhatIf

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

Тип :

SwitchParameter

Псевдонимы:

wi

Позиция:

Именованный

Значение по умолчанию:

False

Необходимый:

False

Примите ввод конвейера:

False

Принимайте подстановочные знаки:

False

Входы

PSVariable

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

Выходы

Нет

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

Примечания

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

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

      rv

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