Clear-Variable

  • Referência
Módulo:
Microsoft.PowerShell.Utility

Excluir o valor de uma variável.

Syntax

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

Description

O Clear-Variable cmdlet exclui os dados armazenados em uma variável, mas não exclui a variável. Como resultado, o valor da variável é NULL (vazio). Se a variável tiver um dado ou tipo de objeto especificado, esse cmdlet preservará o tipo do objeto armazenado na variável.

Exemplos

Exemplo 1: Remover o valor de variáveis globais que começam com uma cadeia de caracteres de pesquisa

Clear-Variable my* -Scope Global

Esse comando remove o valor de variáveis globais que têm nomes que começam com my.

Exemplo 2: Limpar uma variável em um escopo filho, mas não o escopo pai

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

3

Esses comandos demonstram que apagar uma variável em um escopo filho não apaga o valor no escopo pai. O primeiro comando define o valor da variável $a como 3. O segundo comando usa o operador invoke (&) para executar o Clear-Variable comando em um novo escopo. A variável é apagada no escopo filho (embora ela não exista), mas não será apagada no escopo local. O terceiro comando, que obtém o valor de $a, mostra que o valor 3 não é afetado.

Exemplo 3: Excluir o valor da variável especificada

Clear-Variable -Name "Processes"

Esse comando exclui o valor da variável chamada Processes. Depois que o cmdlet concluir a operação, a variável chamada Processes ainda existirá, mas o valor será null.

Parâmetros

-Confirm

Solicita sua confirmação antes de executar o cmdlet.

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

-Exclude

Especifica uma matriz de itens que esse cmdlet omite na operação. O valor desse parâmetro qualifica o parâmetro Name . Insira um elemento Name ou padrão, como "*s". Caracteres curinga são permitidos.

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

-Force

Permite que o cmdlet apaga uma variável, mesmo se for somente leitura. Mesmo usando o parâmetro Force, o cmdlet não pode remover uma constante.

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

-Include

Especifica uma matriz de itens que esse cmdlet inclui na operação. O valor desse parâmetro qualifica o parâmetro Name . Insira um elemento Name ou padrão, como "*s". Caracteres curinga são permitidos.

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

-Name

Especifica o nome da variável a ser apagada. Caracteres curinga são permitidos. Esse parâmetro é obrigatório, mas o nome do parâmetro Name é opcional.

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

-PassThru

Retorna um objeto que representa o item com que você está trabalhando. Por padrão, este cmdlet não gera saída.

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

-Scope

Especifica o escopo no qual esse alias é válido.

Os valores aceitáveis para esse parâmetro são:

  • Global
  • Local
  • Script

Você também pode usar um número relativo ao escopo atual (0 até o número de escopos, onde 0 é o escopo atual e 1 é seu pai). Local é o padrão. Para obter mais informações, consulte about_Scopes.

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

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

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

Entradas

None

Não é possível canalizar objetos para esse cmdlet.

Saídas

None

Por padrão, esse cmdlet não retorna nenhuma saída.

PSVariable

Quando você usa o parâmetro PassThru , esse cmdlet retorna um objeto PSVariable que representa a variável limpa.

Observações

O Windows PowerShell inclui os seguintes aliases para Clear-Variable:

  • clv

  • Para excluir uma variável, juntamente com seu valor, use Remove-Variable ou Remove-Item.

    Esse cmdlet não exclui os valores de variáveis definidas como constantes ou de propriedade do sistema, mesmo se você usar o parâmetro Force .

    Se a variável que você está limpando não existir, o cmdlet não terá nenhum efeito. Ele não cria uma variável com um valor nulo.