Compartilhar via

Clear-Variable

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

Exclui o valor de uma variável.

Sintaxe

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

Description

O cmdlet Clear-Variable 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 tipo de objeto ou dados especificado, esse cmdlet preservará o tipo do objeto armazenado na variável.

Exemplos

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

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

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

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

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

Esses comandos demonstram que limpar uma variável em um escopo filho não limpa o valor no escopo pai. O primeiro comando define o valor da variável $A como 3. O segundo comando usa o operador de invocação (&) para executar o comando Clear-Variable em um novo escopo. A variável é desmarcada no escopo filho (embora não existisse), mas não está desmarcada no escopo local. O terceiro comando, que obtém o valor de $A, mostra que o valor 3 não foi afetado.

Exemplo 3: excluir o valor da variável especificada

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

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

Parâmetros

-Confirm

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

Tipo:SwitchParameter
Aliases:cf
Cargo:Named
Valor padrão:False
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga: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 ou padrão de nome, como "s*". Curingas são permitidos.

Tipo:String[]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:True

-Force

Permite que o cmdlet desmarque uma variável mesmo que seja somente leitura. Mesmo usando o parâmetro Force, o cmdlet não pode limpar constantes.

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga: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 ou padrão de nome, como "s*". Curingas são permitidos.

Tipo:String[]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:True

-Name

Especifica o nome da variável a ser desmarcada. Curingas são permitidos. Esse parâmetro é necessário, mas o nome do parâmetro ("Name") é opcional.

Tipo:String[]
Cargo:0
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:True

-PassThru

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

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Scope

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

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

  • Global
  • Local
  • Roteiro

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

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-WhatIf

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

Tipo:SwitchParameter
Aliases:wi
Cargo:Named
Valor padrão:False
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

Entradas

None

Você não pode redirecionar objetos para este cmdlet.

Saídas

None or System.Management.Automation.PSVariable

Quando você usa o parâmetro PassThru, esse cmdlet gera um objeto System.Management.Automation.PSVariable que representa a variável desmarcada. Caso contrário, esse cmdlet não gerará nenhuma saída.

Observações

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

    Esse cmdlet não exclui os valores de variáveis definidas como constantes ou pertencentes ao sistema, mesmo que você use o parâmetro Force.

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

    Você também pode consultar de Variável Clara por seu alias interno, clv. Para obter mais informações, consulte about_Aliases.