Clear-Variable (Microsoft.PowerShell.Utility)

Clear-Variable

Модуль:

Microsoft.PowerShell.Utility

Удаляет значение переменной.

Синтаксис

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

Описание

Командлет Clear-Variable удаляет данные, хранящиеся в переменной, но не удаляет саму переменную. В результате значение переменной равно NULL (пусто). Если переменная имеет указанный тип данных или объекта, этот командлет сохраняет тип объекта, хранящегося в переменной.

Примеры

Пример 1. Удаление значений глобальных переменных, которые начинаются со строки поиска.

Clear-Variable my* -Scope Global

Эта команда удаляет значения глобальных переменных, имена которых начинаются с my.

Пример 2. Очистите переменную в дочерней области, но не в родительской.

$a=3
&{ Clear-Variable a }
$a

3

Эти команды демонстрируют, что очистка переменной в дочерней области не очищает значение в родительской области. Первая команда устанавливает значение переменной $a равным 3. Вторая команда использует оператор вызова (&) для запуска Clear-Variable. > команда в новой области. Переменная очищается в дочерней области (хотя она не существует), но не очищается в локальной области. Третья команда, получающая значение $a, показывает, что значение 3 не затронуто.

Пример 3: Удаление значения указанной переменной

Clear-Variable -Name "Processes"

Эта команда удаляет значение переменной с именем Processes. После того как командлет завершит операцию, переменная с именем Processes все еще существует, но ее значение равно нулю.

Параметры

-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

Указывает имя очищаемой переменной. Подстановочные знаки разрешены. Этот параметр является обязательным, однако имя параметра Name является необязательным.

Тип :

String[]

Позиция:

0

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

None

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

True

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

True

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

True

-PassThru

Возвращает объект, представляющий элемент, с которым вы работаете. По умолчанию этот командлет не генерирует никаких выходных данных.

Тип :

SwitchParameter

Позиция:

Именованный

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

None

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

False

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

False

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

False

-Scope

Указывает область, в которой действителен этот псевдоним.

Допустимые значения этого параметра:

Global

Local

Script

Вы также можете использовать число относительно текущей области (от 0 до количества областей, где 0 — текущая область, а 1 — ее родительская область). Локальный — значение по умолчанию. Дополнительные сведения см. в разделе about_Scopes.

Тип :

String

Позиция:

Именованный

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

None

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

False

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

False

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

False

-WhatIf

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

Тип :

SwitchParameter

Псевдонимы:

wi

Позиция:

Именованный

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

False

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

False

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

False

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

False

Входы

Нет

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

Выходы

Нет

По умолчанию этот командлет не возвращает никаких результатов.

PSVariable

При использовании параметра PassThru этот командлет возвращает объект PSVariable, представляющий очищенную переменную.

Примечания

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

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

  clv

• Чтобы удалить переменную вместе с ее значением, используйте Remove-Variable или Remove-Item.

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

  Если очищаемая переменная не существует, командлет не оказывает никакого эффекта. Он не создает переменную с нулевым значением.