Compartilhar via

Remove-Variable

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

Exclui uma variável e seu valor.

Sintaxe

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

Description

O cmdlet Remove-Variable exclui uma variável e seu valor do escopo no qual ele é definido, como a sessão atual. Você não pode usar esse cmdlet para excluir variáveis que são definidas como constantes ou aquelas que pertencem ao sistema.

Exemplos

Exemplo 1: remover uma variável

PS C:\> Remove-Variable Smp

Esse comando exclui a variável $Smp.

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 da 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:False

-Force

Indica que o cmdlet remove uma variável mesmo que seja somente leitura. Mesmo usando o parâmetro Force, o cmdlet não pode remover uma constante.

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 exclui 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:False

-Name

Especifica o nome da variável a ser removida. 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:False

-Scope

Obtém apenas as variáveis no escopo especificado. Os valores aceitáveis para este parâmetro são:

  • Global
  • Local
  • Roteiro
  • Um número relativo ao escopo atual (0 por meio do número de escopos, em que 0 é o escopo atual e 1 é seu 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

PSVariable

Você pode canalizar um objeto variável para Remove-Variable.

Saídas

None

Esse cmdlet não retorna nenhuma saída.

Observações

  • As alterações afetam apenas o escopo atual, como uma sessão. Para excluir uma variável de todas as sessões, adicione um comando Remove-Variable ao seu perfil do Windows PowerShell.

    Você também pode consultar Remove-Variable por seu alias interno, rv. Para obter mais informações, consulte about_Aliases.